diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index cc064f7f85..129b381cef 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -4122,6 +4126,236 @@ } } }, + "/enterprises/{enterprise}/dependabot/repository-access": { + "get": { + "summary": "Lists the repositories Dependabot can access in an enterprise", + "description": "Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-repository-access-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-repository-access-details" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an enterprise", + "description": "Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot in an enterprise", + "description": "Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -10561,6 +10795,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -16855,6 +17093,9 @@ "schema": { "type": "object", "additionalProperties": false, + "required": [ + "selected_repository_ids" + ], "properties": { "selected_repository_ids": { "type": "array", @@ -33535,6 +33776,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -64474,6 +64719,15 @@ }, "assignee": { "$ref": "#/components/schemas/secret-scanning-alert-assignee" + }, + "validity": { + "type": "string", + "nullable": true, + "enum": [ + "active", + "inactive" + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -64540,7 +64794,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -86577,11 +86831,11 @@ } } }, - "issues-labeled": { + "issues-field-added": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue field value was set or updated on an issue.", + "operationId": "issues/field-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86648,7 +86902,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-field-added" } } } @@ -86670,11 +86924,11 @@ } } }, - "issues-locked": { + "issues-field-removed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue field value was cleared from an issue.", + "operationId": "issues/field-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86741,7 +86995,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-field-removed" } } } @@ -86763,11 +87017,11 @@ } } }, - "issues-milestoned": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86834,7 +87088,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -86856,11 +87110,11 @@ } } }, - "issues-opened": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86927,7 +87181,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -86949,11 +87203,11 @@ } } }, - "issues-pinned": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87020,7 +87274,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -87042,11 +87296,11 @@ } } }, - "issues-reopened": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87113,7 +87367,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -87135,11 +87389,11 @@ } } }, - "issues-transferred": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87206,7 +87460,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -87228,11 +87482,11 @@ } } }, - "issues-typed": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was added to an issue.", - "operationId": "issues/typed", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87299,7 +87553,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -87321,11 +87575,11 @@ } } }, - "issues-unassigned": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87392,7 +87646,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -87414,11 +87668,11 @@ } } }, - "issues-unlabeled": { + "issues-typed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87485,7 +87739,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-typed" } } } @@ -87507,11 +87761,11 @@ } } }, - "issues-unlocked": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87578,7 +87832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -87600,11 +87854,11 @@ } } }, - "issues-unpinned": { + "issues-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87671,7 +87925,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -87693,11 +87947,11 @@ } } }, - "issues-untyped": { + "issues-unlocked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was removed from an issue.", - "operationId": "issues/untyped", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87764,7 +88018,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -87786,13 +88040,13 @@ } } }, - "label-created": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -87814,7 +88068,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "label", + "example": "issues", "schema": { "type": "string" } @@ -87857,7 +88111,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -87870,7 +88124,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -87879,11 +88133,104 @@ } } }, - "label-deleted": { + "issues-untyped": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue type was removed from an issue.", + "operationId": "issues/untyped", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-untyped" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, @@ -87950,7 +88297,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -87972,11 +88319,11 @@ } } }, - "label-edited": { + "label-deleted": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, @@ -88043,7 +88390,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -88065,13 +88412,13 @@ } } }, - "marketplace-purchase-cancelled": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -88093,7 +88440,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "marketplace_purchase", + "example": "label", "schema": { "type": "string" } @@ -88136,7 +88483,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -88149,18 +88496,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88227,7 +88576,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -88247,11 +88596,11 @@ } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-changed": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88318,7 +88667,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -88338,11 +88687,11 @@ } } }, - "marketplace-purchase-pending-change-cancelled": { + "marketplace-purchase-pending-change": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88409,7 +88758,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -88429,11 +88778,11 @@ } } }, - "marketplace-purchase-purchased": { + "marketplace-purchase-pending-change-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88500,7 +88849,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -88520,13 +88869,13 @@ } } }, - "member-added": { + "marketplace-purchase-purchased": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -88548,7 +88897,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "member", + "example": "marketplace_purchase", "schema": { "type": "string" } @@ -88591,7 +88940,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" } } } @@ -88604,21 +88953,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "member-edited": { + "member-added": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, @@ -88685,7 +89031,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -88708,11 +89054,11 @@ } } }, - "member-removed": { + "member-edited": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, @@ -88779,7 +89125,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -88802,13 +89148,13 @@ } } }, - "membership-added": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -88830,7 +89176,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "membership", + "example": "member", "schema": { "type": "string" } @@ -88873,7 +89219,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -88886,20 +89232,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "membership-removed": { + "membership-added": { "post": { "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" }, @@ -88966,7 +89313,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -88988,16 +89335,13 @@ } } }, - "merge-group-checks-requested": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -89019,7 +89363,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "merge_group", + "example": "membership", "schema": { "type": "string" } @@ -89062,7 +89406,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -89075,18 +89419,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "membership", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "merge-group-destroyed": { + "merge-group-checks-requested": { "post": { "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" ], @@ -89156,7 +89502,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -89176,201 +89522,16 @@ } } }, - "meta-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#meta" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "meta", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "meta", - "supported-webhook-types": [ - "marketplace", - "business", - "repository", - "organization", - "app" - ] - } - } - }, - "milestone-closed": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "milestone", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "milestone", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "milestone-created": { - "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -89392,7 +89553,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "milestone", + "example": "merge_group", "schema": { "type": "string" } @@ -89435,7 +89596,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -89448,22 +89609,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "merge_group", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "milestone-deleted": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -89485,7 +89644,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "milestone", + "example": "meta", "schema": { "type": "string" } @@ -89528,7 +89687,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -89541,8 +89700,10 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "meta", "supported-webhook-types": [ + "marketplace", + "business", "repository", "organization", "app" @@ -89550,11 +89711,11 @@ } } }, - "milestone-edited": { + "milestone-closed": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -89621,7 +89782,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -89643,11 +89804,11 @@ } } }, - "milestone-opened": { + "milestone-created": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -89714,100 +89875,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "milestone", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "org-block-blocked": { - "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "org_block", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -89820,22 +89888,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "org-block-unblocked": { + "milestone-deleted": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -89857,7 +89925,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "org_block", + "example": "milestone", "schema": { "type": "string" } @@ -89900,7 +89968,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -89913,22 +89981,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-deleted": { + "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -89950,7 +90018,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "organization", + "example": "milestone", "schema": { "type": "string" } @@ -89993,7 +90061,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -90006,7 +90074,193 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-opened": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "milestone", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-milestone-opened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "org-block-blocked": { + "post": { + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "org_block", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-org-block-blocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "org_block", "supported-webhook-types": [ "organization", "business", @@ -90015,13 +90269,13 @@ } } }, - "organization-member-added": { + "org-block-unblocked": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -90043,7 +90297,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "organization", + "example": "org_block", "schema": { "type": "string" } @@ -90086,7 +90340,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -90099,7 +90353,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "org_block", "supported-webhook-types": [ "organization", "business", @@ -90108,11 +90362,11 @@ } } }, - "organization-member-invited": { + "organization-deleted": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90179,7 +90433,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -90201,11 +90455,11 @@ } } }, - "organization-member-removed": { + "organization-member-added": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90272,7 +90526,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -90294,11 +90548,11 @@ } } }, - "organization-renamed": { + "organization-member-invited": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90365,7 +90619,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -90387,13 +90641,13 @@ } } }, - "package-published": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -90415,7 +90669,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "package", + "example": "organization", "schema": { "type": "string" } @@ -90458,7 +90712,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -90471,21 +90725,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", - "organization" + "organization", + "business", + "app" ] } } }, - "package-updated": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -90507,7 +90762,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "package", + "example": "organization", "schema": { "type": "string" } @@ -90550,7 +90805,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -90563,20 +90818,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", - "organization" + "organization", + "business", + "app" ] } } }, - "page-build": { + "package-published": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -90598,7 +90855,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "page_build", + "example": "package", "schema": { "type": "string" } @@ -90641,7 +90898,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -90654,22 +90911,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "package", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "personal-access-token-request-approved": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was approved.", - "operationId": "personal-access-token-request/approved", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -90680,6 +90936,38 @@ "type": "string" } }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "package", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, { "name": "X-GitHub-Delivery", "in": "header", @@ -90689,9 +90977,52 @@ } }, { - "name": "X-Github-Event", + "name": "X-Hub-Signature-256", "in": "header", - "example": "personal_access_token_request", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "package", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "page-build": { + "post": { + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" } @@ -90704,6 +91035,14 @@ "type": "string" } }, + { + "name": "X-Github-Event", + "in": "header", + "example": "page_build", + "schema": { + "type": "string" + } + }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", @@ -90715,7 +91054,15 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "integration", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -90734,7 +91081,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -90747,19 +91094,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "page_build", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "personal-access-token-request-cancelled": { + "personal-access-token-request-approved": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was cancelled by the requester.", - "operationId": "personal-access-token-request/cancelled", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -90826,7 +91174,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -90847,11 +91195,11 @@ } } }, - "personal-access-token-request-created": { + "personal-access-token-request-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was created.", - "operationId": "personal-access-token-request/created", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -90918,7 +91266,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -90939,11 +91287,11 @@ } } }, - "personal-access-token-request-denied": { + "personal-access-token-request-created": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was denied.", - "operationId": "personal-access-token-request/denied", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -91010,7 +91358,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -91031,12 +91379,13 @@ } } }, - "ping": { + "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -91048,9 +91397,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -91058,31 +91407,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "ping", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -91101,22 +91450,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-ping" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-ping-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping-form-encoded" - } + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -91128,26 +91462,132 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app", - "business", - "marketplace" + "organization" ] } } }, - "project-card-converted": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "ping", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "ping", + "supported-webhook-types": [ + "repository", + "organization", + "app", + "business", + "marketplace" + ] + } + } + }, + "project-card-converted": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -107962,6 +108402,329 @@ ], "additionalProperties": false }, + "nullable-simple-repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "nullable": true + }, + "dependabot-repository-access-details": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true + }, + "accessible_repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/nullable-simple-repository" + } + } + }, + "additionalProperties": false + }, "enterprise-team": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", @@ -113356,6 +114119,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -115618,329 +116385,6 @@ ], "additionalProperties": true }, - "nullable-simple-repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ], - "nullable": true - }, - "dependabot-repository-access-details": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", - "type": "object", - "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal", - "nullable": true - }, - "accessible_repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/nullable-simple-repository" - } - } - }, - "additionalProperties": false - }, "organization-dependabot-secret": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", @@ -125318,6 +125762,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -182829,6 +183281,306 @@ "sender" ] }, + "webhook-issues-field-added": { + "title": "issues field_added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "field_added" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was set or updated on the issue.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "field_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was set or updated for the issue field. When updating an existing value, the previous value is available in `changes`.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + }, + "changes": { + "type": "object", + "description": "The previous field value, present when an existing value was updated.", + "properties": { + "issue_field_value": { + "type": "object", + "description": "The previous issue field value data.", + "properties": { + "from": { + "type": "object", + "description": "The previous value of the issue field before the update.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The previous value. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the previously selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The previously selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "from" + ] + } + } + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "issue_field", + "repository", + "sender" + ] + }, + "webhook-issues-field-removed": { + "title": "issues field_removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "field_removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was cleared from the issue.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "field_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was cleared from the issue field.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "issue_field", + "repository", + "sender" + ] + }, "webhook-issues-labeled": { "title": "issues labeled event", "type": "object", @@ -288816,6 +289568,84 @@ } ] }, + "dependabot-repository-access-details": { + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } + }, "enterprise-teams-items": { "value": [ { @@ -293241,84 +294071,6 @@ } ] }, - "dependabot-repository-access-details": { - "value": { - "default_level": "public", - "accessible_repositories": [ - { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", - "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, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" - }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" - } - ] - } - }, "organization-dependabot-secret-paginated": { "value": { "total_count": 3, diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index e712cc85c7..b4107953db 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -73,6 +73,9 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot @@ -2991,6 +2994,179 @@ paths: previews: [] category: dependabot subcategory: alerts + "/enterprises/{enterprise}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an enterprise + description: |- + Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/dependabot-repository-access-details" + examples: + default: + "$ref": "#/components/examples/dependabot-repository-access-details" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an enterprise + description: |- + Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + "/enterprises/{enterprise}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot in an enterprise + description: |- + Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -7577,6 +7753,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -12242,6 +12424,8 @@ paths: schema: type: object additionalProperties: false + required: + - selected_repository_ids properties: selected_repository_ids: type: array @@ -24474,6 +24658,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -46903,6 +47092,14 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" assignee: "$ref": "#/components/schemas/secret-scanning-alert-assignee" + validity: + type: string + nullable: true + enum: + - active + - inactive + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -46941,7 +47138,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -62683,7 +62881,7 @@ x-webhooks: - repository - organization - app - issues-labeled: + issues-field-added: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62691,8 +62889,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue field value was set or updated on an issue. + operationId: issues/field-added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62736,7 +62934,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-field-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62749,7 +62947,7 @@ x-webhooks: - repository - organization - app - issues-locked: + issues-field-removed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62757,9 +62955,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue field value was cleared from an issue. + operationId: issues/field-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62803,7 +63000,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-field-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62816,7 +63013,7 @@ x-webhooks: - repository - organization - app - issues-milestoned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62824,8 +63021,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62869,7 +63066,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62882,7 +63079,7 @@ x-webhooks: - repository - organization - app - issues-opened: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62890,9 +63087,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62936,7 +63133,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62949,7 +63146,7 @@ x-webhooks: - repository - organization - app - issues-pinned: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62957,9 +63154,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63003,7 +63199,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63016,7 +63212,7 @@ x-webhooks: - repository - organization - app - issues-reopened: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63024,8 +63220,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63069,7 +63266,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63082,7 +63279,7 @@ x-webhooks: - repository - organization - app - issues-transferred: + issues-pinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63090,9 +63287,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63136,7 +63333,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63149,7 +63346,7 @@ x-webhooks: - repository - organization - app - issues-typed: + issues-reopened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63157,8 +63354,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: A closed issue was reopened. + operationId: issues/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63202,7 +63399,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63215,7 +63412,7 @@ x-webhooks: - repository - organization - app - issues-unassigned: + issues-transferred: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63223,8 +63420,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63268,7 +63466,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63281,7 +63479,7 @@ x-webhooks: - repository - organization - app - issues-unlabeled: + issues-typed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63289,8 +63487,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63334,7 +63532,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63347,7 +63545,7 @@ x-webhooks: - repository - organization - app - issues-unlocked: + issues-unassigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63355,9 +63553,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked + description: A user was unassigned from an issue. + operationId: issues/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63401,7 +63598,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63414,7 +63611,7 @@ x-webhooks: - repository - organization - app - issues-unpinned: + issues-unlabeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63422,9 +63619,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned + description: A label was removed from an issue. + operationId: issues/unlabeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63468,7 +63664,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63481,7 +63677,7 @@ x-webhooks: - repository - organization - app - issues-untyped: + issues-unlocked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63489,8 +63685,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was removed from an issue. - operationId: issues/untyped + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63534,7 +63731,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-issues-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63547,18 +63744,19 @@ x-webhooks: - repository - organization - app - label-created: + issues-unpinned: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was created. - operationId: label/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was unpinned from a repository. For more information, + see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -63572,7 +63770,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: label + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63600,7 +63798,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63608,23 +63806,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-deleted: + issues-untyped: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was deleted. - operationId: label/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was removed from an issue. + operationId: issues/untyped externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -63638,7 +63836,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: label + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63666,7 +63864,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-untyped" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63674,12 +63872,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-edited: + label-created: post: summary: |- This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. @@ -63687,8 +63885,8 @@ x-webhooks: If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label's name, description, or color was changed. - operationId: label/edited + description: A label was created. + operationId: label/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: @@ -63732,7 +63930,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63745,19 +63943,18 @@ x-webhooks: - repository - organization - app - marketplace-purchase-cancelled: + label-deleted: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a GitHub Marketplace plan, and the last billing - cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/cancelled + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was deleted. + operationId: label/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -63771,7 +63968,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: marketplace_purchase + example: label schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63799,7 +63996,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63807,22 +64004,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: label supported-webhook-types: - - marketplace - marketplace-purchase-changed: + - repository + - organization + - app + label-edited: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone upgraded or downgraded a GitHub Marketplace plan, and the - last billing cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/changed + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label's name, description, or color was changed. + operationId: label/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -63836,7 +64034,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: marketplace_purchase + example: label schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63864,7 +64062,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-label-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63872,10 +64070,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: label supported-webhook-types: - - marketplace - marketplace-purchase-pending-change: + - repository + - organization + - app + marketplace-purchase-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -63883,11 +64083,9 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone downgraded or cancelled a GitHub Marketplace plan. The - new plan or cancellation will take effect at the end of the current billing - cycle. When the change takes effect, the `changed` or `cancelled` event will - be sent. - operationId: marketplace-purchase/pending-change + description: Someone cancelled a GitHub Marketplace plan, and the last billing + cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -63931,7 +64129,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63942,7 +64140,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-pending-change-cancelled: + marketplace-purchase-changed: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -63950,10 +64148,9 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone cancelled a pending change to a GitHub Marketplace plan. - Pending changes include plan cancellations and downgrades that will take effect - at the end of a billing cycle. - operationId: marketplace-purchase/pending-change-cancelled + description: Someone upgraded or downgraded a GitHub Marketplace plan, and the + last billing cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/changed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -63997,7 +64194,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64008,7 +64205,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-purchased: + marketplace-purchase-pending-change: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -64016,9 +64213,11 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone purchased a GitHub Marketplace plan. The change will take - effect on the account immediately. - operationId: marketplace-purchase/purchased + description: Someone downgraded or cancelled a GitHub Marketplace plan. The + new plan or cancellation will take effect at the end of the current billing + cycle. When the change takes effect, the `changed` or `cancelled` event will + be sent. + operationId: marketplace-purchase/pending-change externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -64062,7 +64261,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64073,16 +64272,20 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - member-added: + marketplace-purchase-pending-change-cancelled: post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A GitHub user accepted an invitation to a repository. - operationId: member/added + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone cancelled a pending change to a GitHub Marketplace plan. + Pending changes include plan cancellations and downgrades that will take effect + at the end of a billing cycle. + operationId: marketplace-purchase/pending-change-cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -64096,7 +64299,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: member + example: marketplace_purchase schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64124,7 +64327,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64132,22 +64335,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: marketplace_purchase supported-webhook-types: - - business - - repository - - organization - - app - member-edited: + - marketplace + marketplace-purchase-purchased: post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: Permissions were changed for a collaborator on a repository. - operationId: member/edited + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone purchased a GitHub Marketplace plan. The change will take + effect on the account immediately. + operationId: marketplace-purchase/purchased externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -64161,7 +64364,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: member + example: marketplace_purchase schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64189,7 +64392,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64197,20 +64400,17 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: marketplace_purchase supported-webhook-types: - - business - - repository - - organization - - app - member-removed: + - marketplace + member-added: post: summary: |- This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A collaborator was removed from a repository. - operationId: member/removed + description: A GitHub user accepted an invitation to a repository. + operationId: member/added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: @@ -64254,7 +64454,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64268,16 +64468,16 @@ x-webhooks: - repository - organization - app - membership-added: + member-edited: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was added to a team. - operationId: membership/added + description: Permissions were changed for a collaborator on a repository. + operationId: member/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -64291,7 +64491,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: membership + example: member schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64319,7 +64519,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-member-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64327,21 +64527,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: member supported-webhook-types: - - organization - business + - repository + - organization - app - membership-removed: + member-removed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was removed from a team. - operationId: membership/removed + description: A collaborator was removed from a repository. + operationId: member/removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -64355,7 +64556,136 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: membership + example: member + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-member-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: member + supported-webhook-types: + - business + - repository + - organization + - app + membership-added: + post: + summary: |- + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was added to a team. + operationId: membership/added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: membership + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-membership-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: membership + supported-webhook-types: + - organization + - business + - app + membership-removed: + post: + summary: |- + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was removed from a team. + operationId: membership/removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: membership schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -78434,6 +78764,298 @@ components: - fixed_at - repository additionalProperties: false + nullable-simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the + GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an + archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees + for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git + blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches + in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators + of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments + on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits + on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits + of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs + of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags + of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events + on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues + on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy + keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels + of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones + of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications + on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests + on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases + on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses + of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git + tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + nullable: true + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able to access + in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + "$ref": "#/components/schemas/nullable-simple-repository" + additionalProperties: false enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -82589,6 +83211,11 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim format + for the organization. When `true`, new OIDC tokens will use a stable, + repository-ID-based `sub` claim instead of the name-based format. + type: boolean required: - include_claim_keys empty-object: @@ -84459,298 +85086,6 @@ components: required: - date additionalProperties: true - nullable-simple-repository: - title: Simple Repository - description: A GitHub repository. - type: object - properties: - id: - type: integer - format: int64 - example: 1296269 - description: A unique identifier of the repository. - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - description: The GraphQL identifier of the repository. - name: - type: string - example: Hello-World - description: The name of the repository. - full_name: - type: string - example: octocat/Hello-World - description: The full, globally unique, name of the repository. - owner: - "$ref": "#/components/schemas/simple-user" - private: - type: boolean - description: Whether the repository is private. - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: The URL to view the repository on GitHub.com. - description: - type: string - example: This your first repo! - nullable: true - description: The repository description. - fork: - type: boolean - description: Whether the repository is a fork. - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - description: The URL to get more information about the repository from the - GitHub API. - archive_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - description: A template for the API URL to download the repository as an - archive. - assignees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - description: A template for the API URL to list the available assignees - for issues in the repository. - blobs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - description: A template for the API URL to create or retrieve a raw Git - blob in the repository. - branches_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - description: A template for the API URL to get information about branches - in the repository. - collaborators_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - description: A template for the API URL to get information about collaborators - of the repository. - comments_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/comments{/number} - description: A template for the API URL to get information about comments - on the repository. - commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - description: A template for the API URL to get information about commits - on the repository. - compare_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - description: A template for the API URL to compare two commits or refs. - contents_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - description: A template for the API URL to get the contents of the repository. - contributors_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/contributors - description: A template for the API URL to list the contributors to the - repository. - deployments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/deployments - description: The API URL to list the deployments of the repository. - downloads_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/downloads - description: The API URL to list the downloads on the repository. - events_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/events - description: The API URL to list the events of the repository. - forks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/forks - description: The API URL to list the forks of the repository. - git_commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - description: A template for the API URL to get information about Git commits - of the repository. - git_refs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - description: A template for the API URL to get information about Git refs - of the repository. - git_tags_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - description: A template for the API URL to get information about Git tags - of the repository. - issue_comment_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - description: A template for the API URL to get information about issue comments - on the repository. - issue_events_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - description: A template for the API URL to get information about issue events - on the repository. - issues_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues{/number} - description: A template for the API URL to get information about issues - on the repository. - keys_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - description: A template for the API URL to get information about deploy - keys on the repository. - labels_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/labels{/name} - description: A template for the API URL to get information about labels - of the repository. - languages_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/languages - description: The API URL to get information about the languages of the repository. - merges_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/merges - description: The API URL to merge branches in the repository. - milestones_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - description: A template for the API URL to get information about milestones - of the repository. - notifications_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - description: A template for the API URL to get information about notifications - on the repository. - pulls_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - description: A template for the API URL to get information about pull requests - on the repository. - releases_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/releases{/id} - description: A template for the API URL to get information about releases - on the repository. - stargazers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/stargazers - description: The API URL to list the stargazers on the repository. - statuses_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - description: A template for the API URL to get information about statuses - of a commit. - subscribers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscribers - description: The API URL to list the subscribers on the repository. - subscription_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscription - description: The API URL to subscribe to notifications for this repository. - tags_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/tags - description: The API URL to get information about tags on the repository. - teams_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/teams - description: The API URL to list the teams on the repository. - trees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - description: A template for the API URL to create or retrieve a raw Git - tree of the repository. - hooks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks - description: The API URL to list the hooks on the repository. - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - nullable: true - dependabot-repository-access-details: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able to access - in an organization - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot updates. - enum: - - public - - internal - example: internal - nullable: true - accessible_repositories: - type: array - items: - "$ref": "#/components/schemas/nullable-simple-repository" - additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -92135,6 +92470,15 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable OIDC subject + claim format. When `true`, OIDC tokens will use a stable, repository-ID-based + `sub` claim. If not set at the repository level, falls back to the organization-level + setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default actions-secret: @@ -135272,6 +135616,219 @@ components: - issue - repository - sender + webhook-issues-field-added: + title: issues field_added event + type: object + properties: + action: + type: string + enum: + - field_added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + issue_field: + type: object + description: The issue field whose value was set or updated on the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was set or updated for the issue field. When + updating an existing value, the previous value is available in `changes`. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, and number + field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present for single_select + field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + changes: + type: object + description: The previous field value, present when an existing value was + updated. + properties: + issue_field_value: + type: object + description: The previous issue field value data. + properties: + from: + type: object + description: The previous value of the issue field before the update. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The previous value. Present for text, date, and + number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the previously selected option. + Present for single_select field types. + option: + type: object + description: The previously selected option details. Present + for single_select field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + required: + - from + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - issue_field + - repository + - sender + webhook-issues-field-removed: + title: issues field_removed event + type: object + properties: + action: + type: string + enum: + - field_removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + issue_field: + type: object + description: The issue field whose value was cleared from the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was cleared from the issue field. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, and number + field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present for single_select + field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - issue_field + - repository + - sender webhook-issues-labeled: title: issues labeled event type: object @@ -216111,6 +216668,78 @@ components: tags_url: https://api.github.com/repos/octo-org/hello-world/tags teams_url: https://api.github.com/repos/octo-org/hello-world/teams trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} + dependabot-repository-access-details: + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks enterprise-teams-items: value: - id: 1 @@ -219861,78 +220490,6 @@ components: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - dependabot-repository-access-details: - value: - default_level: public - accessible_repositories: - - id: 123456 - node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= - name: example-repo - full_name: octocat/example-repo - owner: - name: octocat - email: octo@github.com - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://avatars.githubusercontent.com/u/1?v=4 - gravatar_id: 1 - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat/example-repo - 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 - starred_at: '"2020-07-09T00:17:55Z"' - user_view_type: default - private: false - html_url: https://github.com/octocat/example-repo - description: This is an example repository. - fork: false - url: https://api.github.com/repos/octocat/example-repo - archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} - commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} - compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/example-repo/contributors - deployments_url: https://api.github.com/repos/octocat/example-repo/deployments - downloads_url: https://api.github.com/repos/octocat/example-repo/downloads - events_url: https://api.github.com/repos/octocat/example-repo/events - forks_url: https://api.github.com/repos/octocat/example-repo/forks - git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} - keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} - languages_url: https://api.github.com/repos/octocat/example-repo/languages - merges_url: https://api.github.com/repos/octocat/example-repo/merges - milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} - releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers - statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/example-repo/subscription - tags_url: https://api.github.com/repos/octocat/example-repo/tags - teams_url: https://api.github.com/repos/octocat/example-repo/teams - trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/example-repo/hooks organization-dependabot-secret-paginated: value: total_count: 3 diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index ca0d6e928a..87f350ea86 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -4122,6 +4126,236 @@ } } }, + "/enterprises/{enterprise}/dependabot/repository-access": { + "get": { + "summary": "Lists the repositories Dependabot can access in an enterprise", + "description": "Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-repository-access-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-repository-access-details" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an enterprise", + "description": "Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot in an enterprise", + "description": "Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -10560,6 +10794,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -16815,6 +17053,9 @@ "schema": { "type": "object", "additionalProperties": false, + "required": [ + "selected_repository_ids" + ], "properties": { "selected_repository_ids": { "type": "array", @@ -33488,6 +33729,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -37018,7 +37263,7 @@ ], "responses": { "200": { - "description": "Response including the workflow run ID and URLs when `return_run_details` parameter is `true`.", + "description": "Response including the workflow run ID and URLs.", "content": { "application/json": { "schema": { @@ -64391,6 +64636,15 @@ }, "assignee": { "$ref": "#/components/schemas/secret-scanning-alert-assignee" + }, + "validity": { + "type": "string", + "nullable": true, + "enum": [ + "active", + "inactive" + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -64457,7 +64711,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -86462,11 +86716,11 @@ } } }, - "issues-labeled": { + "issues-field-added": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue field value was set or updated on an issue.", + "operationId": "issues/field-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86533,7 +86787,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-field-added" } } } @@ -86555,11 +86809,11 @@ } } }, - "issues-locked": { + "issues-field-removed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue field value was cleared from an issue.", + "operationId": "issues/field-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86626,7 +86880,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-field-removed" } } } @@ -86648,11 +86902,11 @@ } } }, - "issues-milestoned": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86719,7 +86973,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -86741,11 +86995,11 @@ } } }, - "issues-opened": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86812,7 +87066,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -86834,11 +87088,11 @@ } } }, - "issues-pinned": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86905,7 +87159,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -86927,11 +87181,11 @@ } } }, - "issues-reopened": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -86998,7 +87252,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -87020,11 +87274,11 @@ } } }, - "issues-transferred": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87091,7 +87345,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -87113,11 +87367,11 @@ } } }, - "issues-typed": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was added to an issue.", - "operationId": "issues/typed", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87184,7 +87438,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -87206,11 +87460,11 @@ } } }, - "issues-unassigned": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87277,7 +87531,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -87299,11 +87553,11 @@ } } }, - "issues-unlabeled": { + "issues-typed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87370,7 +87624,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-typed" } } } @@ -87392,11 +87646,11 @@ } } }, - "issues-unlocked": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87463,7 +87717,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -87485,11 +87739,11 @@ } } }, - "issues-unpinned": { + "issues-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87556,7 +87810,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -87578,11 +87832,11 @@ } } }, - "issues-untyped": { + "issues-unlocked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was removed from an issue.", - "operationId": "issues/untyped", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87649,7 +87903,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -87671,13 +87925,13 @@ } } }, - "label-created": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -87699,7 +87953,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "label", + "example": "issues", "schema": { "type": "string" } @@ -87742,7 +87996,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -87755,7 +88009,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -87764,11 +88018,104 @@ } } }, - "label-deleted": { + "issues-untyped": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue type was removed from an issue.", + "operationId": "issues/untyped", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-untyped" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, @@ -87835,7 +88182,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -87857,11 +88204,11 @@ } } }, - "label-edited": { + "label-deleted": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, @@ -87928,7 +88275,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -87950,13 +88297,13 @@ } } }, - "marketplace-purchase-cancelled": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -87978,7 +88325,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "marketplace_purchase", + "example": "label", "schema": { "type": "string" } @@ -88021,7 +88368,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -88034,18 +88381,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88112,7 +88461,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -88132,11 +88481,11 @@ } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-changed": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88203,7 +88552,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -88223,11 +88572,11 @@ } } }, - "marketplace-purchase-pending-change-cancelled": { + "marketplace-purchase-pending-change": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88294,7 +88643,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -88314,11 +88663,11 @@ } } }, - "marketplace-purchase-purchased": { + "marketplace-purchase-pending-change-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88385,7 +88734,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -88405,13 +88754,13 @@ } } }, - "member-added": { + "marketplace-purchase-purchased": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -88433,7 +88782,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "member", + "example": "marketplace_purchase", "schema": { "type": "string" } @@ -88476,7 +88825,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" } } } @@ -88489,21 +88838,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "member-edited": { + "member-added": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, @@ -88570,7 +88916,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -88593,11 +88939,11 @@ } } }, - "member-removed": { + "member-edited": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, @@ -88664,7 +89010,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -88687,13 +89033,13 @@ } } }, - "membership-added": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -88715,7 +89061,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "membership", + "example": "member", "schema": { "type": "string" } @@ -88758,7 +89104,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -88771,20 +89117,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "membership-removed": { + "membership-added": { "post": { "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" }, @@ -88851,7 +89198,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -88873,16 +89220,13 @@ } } }, - "merge-group-checks-requested": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -88904,7 +89248,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "merge_group", + "example": "membership", "schema": { "type": "string" } @@ -88947,7 +89291,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -88960,18 +89304,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "membership", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "merge-group-destroyed": { + "merge-group-checks-requested": { "post": { "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" ], @@ -89041,7 +89387,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -89061,201 +89407,16 @@ } } }, - "meta-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#meta" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "meta", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "meta", - "supported-webhook-types": [ - "marketplace", - "business", - "repository", - "organization", - "app" - ] - } - } - }, - "milestone-closed": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "milestone", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "milestone", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "milestone-created": { - "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -89277,7 +89438,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "milestone", + "example": "merge_group", "schema": { "type": "string" } @@ -89320,7 +89481,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -89333,22 +89494,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "merge_group", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "milestone-deleted": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -89370,7 +89529,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "milestone", + "example": "meta", "schema": { "type": "string" } @@ -89413,7 +89572,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -89426,8 +89585,10 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "meta", "supported-webhook-types": [ + "marketplace", + "business", "repository", "organization", "app" @@ -89435,11 +89596,11 @@ } } }, - "milestone-edited": { + "milestone-closed": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -89506,7 +89667,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -89528,11 +89689,11 @@ } } }, - "milestone-opened": { + "milestone-created": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -89599,100 +89760,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "milestone", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "org-block-blocked": { - "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "org_block", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -89705,22 +89773,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "org-block-unblocked": { + "milestone-deleted": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -89742,7 +89810,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "org_block", + "example": "milestone", "schema": { "type": "string" } @@ -89785,7 +89853,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -89798,22 +89866,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-deleted": { + "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -89835,7 +89903,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "organization", + "example": "milestone", "schema": { "type": "string" } @@ -89878,7 +89946,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -89891,7 +89959,193 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-opened": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "milestone", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-milestone-opened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "org-block-blocked": { + "post": { + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "org_block", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-org-block-blocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "org_block", "supported-webhook-types": [ "organization", "business", @@ -89900,13 +90154,13 @@ } } }, - "organization-member-added": { + "org-block-unblocked": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -89928,7 +90182,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "organization", + "example": "org_block", "schema": { "type": "string" } @@ -89971,7 +90225,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -89984,7 +90238,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "org_block", "supported-webhook-types": [ "organization", "business", @@ -89993,11 +90247,11 @@ } } }, - "organization-member-invited": { + "organization-deleted": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90064,7 +90318,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -90086,11 +90340,11 @@ } } }, - "organization-member-removed": { + "organization-member-added": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90157,7 +90411,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -90179,11 +90433,11 @@ } } }, - "organization-renamed": { + "organization-member-invited": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90250,7 +90504,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -90272,13 +90526,13 @@ } } }, - "package-published": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -90300,7 +90554,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "package", + "example": "organization", "schema": { "type": "string" } @@ -90343,7 +90597,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -90356,21 +90610,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", - "organization" + "organization", + "business", + "app" ] } } }, - "package-updated": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -90392,7 +90647,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "package", + "example": "organization", "schema": { "type": "string" } @@ -90435,7 +90690,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -90448,20 +90703,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", - "organization" + "organization", + "business", + "app" ] } } }, - "page-build": { + "package-published": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -90483,7 +90740,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "page_build", + "example": "package", "schema": { "type": "string" } @@ -90526,7 +90783,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -90539,22 +90796,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "package", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "personal-access-token-request-approved": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was approved.", - "operationId": "personal-access-token-request/approved", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -90565,6 +90821,38 @@ "type": "string" } }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "package", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, { "name": "X-GitHub-Delivery", "in": "header", @@ -90574,9 +90862,52 @@ } }, { - "name": "X-Github-Event", + "name": "X-Hub-Signature-256", "in": "header", - "example": "personal_access_token_request", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "package", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "page-build": { + "post": { + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" } @@ -90589,6 +90920,14 @@ "type": "string" } }, + { + "name": "X-Github-Event", + "in": "header", + "example": "page_build", + "schema": { + "type": "string" + } + }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", @@ -90600,7 +90939,15 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "integration", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -90619,7 +90966,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -90632,19 +90979,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "page_build", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "personal-access-token-request-cancelled": { + "personal-access-token-request-approved": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was cancelled by the requester.", - "operationId": "personal-access-token-request/cancelled", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -90711,7 +91059,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -90732,11 +91080,11 @@ } } }, - "personal-access-token-request-created": { + "personal-access-token-request-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was created.", - "operationId": "personal-access-token-request/created", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -90803,7 +91151,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -90824,11 +91172,11 @@ } } }, - "personal-access-token-request-denied": { + "personal-access-token-request-created": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was denied.", - "operationId": "personal-access-token-request/denied", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -90895,7 +91243,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -90916,12 +91264,13 @@ } } }, - "ping": { + "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -90933,9 +91282,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -90943,31 +91292,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "ping", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -90986,22 +91335,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-ping" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-ping-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping-form-encoded" - } + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -91013,26 +91347,132 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app", - "business", - "marketplace" + "organization" ] } } }, - "project-card-converted": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "ping", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "ping", + "supported-webhook-types": [ + "repository", + "organization", + "app", + "business", + "marketplace" + ] + } + } + }, + "project-card-converted": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -107770,6 +108210,329 @@ ], "additionalProperties": false }, + "nullable-simple-repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "nullable": true + }, + "dependabot-repository-access-details": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true + }, + "accessible_repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/nullable-simple-repository" + } + } + }, + "additionalProperties": false + }, "enterprise-team": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", @@ -112860,6 +113623,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -115122,329 +115889,6 @@ ], "additionalProperties": true }, - "nullable-simple-repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ], - "nullable": true - }, - "dependabot-repository-access-details": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", - "type": "object", - "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal", - "nullable": true - }, - "accessible_repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/nullable-simple-repository" - } - } - }, - "additionalProperties": false - }, "organization-dependabot-secret": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", @@ -124749,6 +125193,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -182403,6 +182855,306 @@ "sender" ] }, + "webhook-issues-field-added": { + "title": "issues field_added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "field_added" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was set or updated on the issue.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "field_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was set or updated for the issue field. When updating an existing value, the previous value is available in `changes`.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + }, + "changes": { + "type": "object", + "description": "The previous field value, present when an existing value was updated.", + "properties": { + "issue_field_value": { + "type": "object", + "description": "The previous issue field value data.", + "properties": { + "from": { + "type": "object", + "description": "The previous value of the issue field before the update.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The previous value. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the previously selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The previously selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "from" + ] + } + } + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "issue_field", + "repository", + "sender" + ] + }, + "webhook-issues-field-removed": { + "title": "issues field_removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "field_removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was cleared from the issue.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "field_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was cleared from the issue field.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "issue_field", + "repository", + "sender" + ] + }, "webhook-issues-labeled": { "title": "issues labeled event", "type": "object", @@ -288072,6 +288824,84 @@ } ] }, + "dependabot-repository-access-details": { + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } + }, "enterprise-teams-items": { "value": [ { @@ -292495,84 +293325,6 @@ } ] }, - "dependabot-repository-access-details": { - "value": { - "default_level": "public", - "accessible_repositories": [ - { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", - "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, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" - }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" - } - ] - } - }, "organization-dependabot-secret-paginated": { "value": { "total_count": 3, diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index 5b9f03cae3..4cfb0fd9f2 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -73,6 +73,9 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot @@ -2991,6 +2994,179 @@ paths: previews: [] category: dependabot subcategory: alerts + "/enterprises/{enterprise}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an enterprise + description: |- + Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/dependabot-repository-access-details" + examples: + default: + "$ref": "#/components/examples/dependabot-repository-access-details" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an enterprise + description: |- + Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + "/enterprises/{enterprise}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot in an enterprise + description: |- + Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -7575,6 +7751,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -12209,6 +12391,8 @@ paths: schema: type: object additionalProperties: false + required: + - selected_repository_ids properties: selected_repository_ids: type: array @@ -24437,6 +24621,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -26930,8 +27119,7 @@ paths: - "$ref": "#/components/parameters/workflow-id" responses: '200': - description: Response including the workflow run ID and URLs when `return_run_details` - parameter is `true`. + description: Response including the workflow run ID and URLs. content: application/json: schema: @@ -46832,6 +47020,14 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" assignee: "$ref": "#/components/schemas/secret-scanning-alert-assignee" + validity: + type: string + nullable: true + enum: + - active + - inactive + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -46870,7 +47066,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -62586,7 +62783,7 @@ x-webhooks: - repository - organization - app - issues-labeled: + issues-field-added: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62594,8 +62791,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue field value was set or updated on an issue. + operationId: issues/field-added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62639,7 +62836,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-field-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62652,7 +62849,7 @@ x-webhooks: - repository - organization - app - issues-locked: + issues-field-removed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62660,9 +62857,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue field value was cleared from an issue. + operationId: issues/field-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62706,7 +62902,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-field-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62719,7 +62915,7 @@ x-webhooks: - repository - organization - app - issues-milestoned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62727,8 +62923,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62772,7 +62968,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62785,7 +62981,7 @@ x-webhooks: - repository - organization - app - issues-opened: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62793,9 +62989,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62839,7 +63035,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62852,7 +63048,7 @@ x-webhooks: - repository - organization - app - issues-pinned: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62860,9 +63056,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62906,7 +63101,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62919,7 +63114,7 @@ x-webhooks: - repository - organization - app - issues-reopened: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62927,8 +63122,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62972,7 +63168,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62985,7 +63181,7 @@ x-webhooks: - repository - organization - app - issues-transferred: + issues-pinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62993,9 +63189,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63039,7 +63235,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63052,7 +63248,7 @@ x-webhooks: - repository - organization - app - issues-typed: + issues-reopened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63060,8 +63256,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: A closed issue was reopened. + operationId: issues/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63105,7 +63301,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63118,7 +63314,7 @@ x-webhooks: - repository - organization - app - issues-unassigned: + issues-transferred: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63126,8 +63322,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63171,7 +63368,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63184,7 +63381,7 @@ x-webhooks: - repository - organization - app - issues-unlabeled: + issues-typed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63192,8 +63389,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63237,7 +63434,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63250,7 +63447,7 @@ x-webhooks: - repository - organization - app - issues-unlocked: + issues-unassigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63258,9 +63455,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked + description: A user was unassigned from an issue. + operationId: issues/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63304,7 +63500,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63317,7 +63513,7 @@ x-webhooks: - repository - organization - app - issues-unpinned: + issues-unlabeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63325,9 +63521,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned + description: A label was removed from an issue. + operationId: issues/unlabeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63371,7 +63566,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63384,7 +63579,7 @@ x-webhooks: - repository - organization - app - issues-untyped: + issues-unlocked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63392,8 +63587,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was removed from an issue. - operationId: issues/untyped + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63437,7 +63633,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-issues-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63450,18 +63646,19 @@ x-webhooks: - repository - organization - app - label-created: + issues-unpinned: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was created. - operationId: label/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was unpinned from a repository. For more information, + see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -63475,7 +63672,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: label + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63503,7 +63700,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63511,23 +63708,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-deleted: + issues-untyped: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was deleted. - operationId: label/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was removed from an issue. + operationId: issues/untyped externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -63541,7 +63738,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: label + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63569,7 +63766,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-untyped" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63577,12 +63774,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-edited: + label-created: post: summary: |- This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. @@ -63590,8 +63787,8 @@ x-webhooks: If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label's name, description, or color was changed. - operationId: label/edited + description: A label was created. + operationId: label/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: @@ -63635,7 +63832,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63648,19 +63845,18 @@ x-webhooks: - repository - organization - app - marketplace-purchase-cancelled: + label-deleted: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a GitHub Marketplace plan, and the last billing - cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/cancelled + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was deleted. + operationId: label/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -63674,7 +63870,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: marketplace_purchase + example: label schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63702,7 +63898,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63710,22 +63906,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: label supported-webhook-types: - - marketplace - marketplace-purchase-changed: + - repository + - organization + - app + label-edited: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone upgraded or downgraded a GitHub Marketplace plan, and the - last billing cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/changed + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label's name, description, or color was changed. + operationId: label/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -63739,7 +63936,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: marketplace_purchase + example: label schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63767,7 +63964,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-label-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63775,10 +63972,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: label supported-webhook-types: - - marketplace - marketplace-purchase-pending-change: + - repository + - organization + - app + marketplace-purchase-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -63786,11 +63985,9 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone downgraded or cancelled a GitHub Marketplace plan. The - new plan or cancellation will take effect at the end of the current billing - cycle. When the change takes effect, the `changed` or `cancelled` event will - be sent. - operationId: marketplace-purchase/pending-change + description: Someone cancelled a GitHub Marketplace plan, and the last billing + cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -63834,7 +64031,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63845,7 +64042,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-pending-change-cancelled: + marketplace-purchase-changed: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -63853,10 +64050,9 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone cancelled a pending change to a GitHub Marketplace plan. - Pending changes include plan cancellations and downgrades that will take effect - at the end of a billing cycle. - operationId: marketplace-purchase/pending-change-cancelled + description: Someone upgraded or downgraded a GitHub Marketplace plan, and the + last billing cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/changed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -63900,7 +64096,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63911,7 +64107,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-purchased: + marketplace-purchase-pending-change: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -63919,9 +64115,11 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone purchased a GitHub Marketplace plan. The change will take - effect on the account immediately. - operationId: marketplace-purchase/purchased + description: Someone downgraded or cancelled a GitHub Marketplace plan. The + new plan or cancellation will take effect at the end of the current billing + cycle. When the change takes effect, the `changed` or `cancelled` event will + be sent. + operationId: marketplace-purchase/pending-change externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -63965,7 +64163,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63976,16 +64174,20 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - member-added: + marketplace-purchase-pending-change-cancelled: post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A GitHub user accepted an invitation to a repository. - operationId: member/added + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone cancelled a pending change to a GitHub Marketplace plan. + Pending changes include plan cancellations and downgrades that will take effect + at the end of a billing cycle. + operationId: marketplace-purchase/pending-change-cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -63999,7 +64201,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: member + example: marketplace_purchase schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64027,7 +64229,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64035,22 +64237,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: marketplace_purchase supported-webhook-types: - - business - - repository - - organization - - app - member-edited: + - marketplace + marketplace-purchase-purchased: post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: Permissions were changed for a collaborator on a repository. - operationId: member/edited + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone purchased a GitHub Marketplace plan. The change will take + effect on the account immediately. + operationId: marketplace-purchase/purchased externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -64064,7 +64266,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: member + example: marketplace_purchase schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64092,7 +64294,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64100,20 +64302,17 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: marketplace_purchase supported-webhook-types: - - business - - repository - - organization - - app - member-removed: + - marketplace + member-added: post: summary: |- This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A collaborator was removed from a repository. - operationId: member/removed + description: A GitHub user accepted an invitation to a repository. + operationId: member/added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: @@ -64157,7 +64356,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64171,16 +64370,16 @@ x-webhooks: - repository - organization - app - membership-added: + member-edited: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was added to a team. - operationId: membership/added + description: Permissions were changed for a collaborator on a repository. + operationId: member/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -64194,7 +64393,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: membership + example: member schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64222,7 +64421,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-member-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64230,21 +64429,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: member supported-webhook-types: - - organization - business + - repository + - organization - app - membership-removed: + member-removed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was removed from a team. - operationId: membership/removed + description: A collaborator was removed from a repository. + operationId: member/removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -64258,7 +64458,136 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: membership + example: member + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-member-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: member + supported-webhook-types: + - business + - repository + - organization + - app + membership-added: + post: + summary: |- + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was added to a team. + operationId: membership/added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: membership + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-membership-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: membership + supported-webhook-types: + - organization + - business + - app + membership-removed: + post: + summary: |- + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was removed from a team. + operationId: membership/removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: membership schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -78272,6 +78601,298 @@ components: - fixed_at - repository additionalProperties: false + nullable-simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the + GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an + archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees + for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git + blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches + in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators + of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments + on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits + on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits + of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs + of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags + of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events + on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues + on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy + keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels + of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones + of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications + on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests + on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases + on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses + of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git + tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + nullable: true + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able to access + in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + "$ref": "#/components/schemas/nullable-simple-repository" + additionalProperties: false enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -82198,6 +82819,11 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim format + for the organization. When `true`, new OIDC tokens will use a stable, + repository-ID-based `sub` claim instead of the name-based format. + type: boolean required: - include_claim_keys empty-object: @@ -84068,298 +84694,6 @@ components: required: - date additionalProperties: true - nullable-simple-repository: - title: Simple Repository - description: A GitHub repository. - type: object - properties: - id: - type: integer - format: int64 - example: 1296269 - description: A unique identifier of the repository. - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - description: The GraphQL identifier of the repository. - name: - type: string - example: Hello-World - description: The name of the repository. - full_name: - type: string - example: octocat/Hello-World - description: The full, globally unique, name of the repository. - owner: - "$ref": "#/components/schemas/simple-user" - private: - type: boolean - description: Whether the repository is private. - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: The URL to view the repository on GitHub.com. - description: - type: string - example: This your first repo! - nullable: true - description: The repository description. - fork: - type: boolean - description: Whether the repository is a fork. - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - description: The URL to get more information about the repository from the - GitHub API. - archive_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - description: A template for the API URL to download the repository as an - archive. - assignees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - description: A template for the API URL to list the available assignees - for issues in the repository. - blobs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - description: A template for the API URL to create or retrieve a raw Git - blob in the repository. - branches_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - description: A template for the API URL to get information about branches - in the repository. - collaborators_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - description: A template for the API URL to get information about collaborators - of the repository. - comments_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/comments{/number} - description: A template for the API URL to get information about comments - on the repository. - commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - description: A template for the API URL to get information about commits - on the repository. - compare_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - description: A template for the API URL to compare two commits or refs. - contents_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - description: A template for the API URL to get the contents of the repository. - contributors_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/contributors - description: A template for the API URL to list the contributors to the - repository. - deployments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/deployments - description: The API URL to list the deployments of the repository. - downloads_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/downloads - description: The API URL to list the downloads on the repository. - events_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/events - description: The API URL to list the events of the repository. - forks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/forks - description: The API URL to list the forks of the repository. - git_commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - description: A template for the API URL to get information about Git commits - of the repository. - git_refs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - description: A template for the API URL to get information about Git refs - of the repository. - git_tags_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - description: A template for the API URL to get information about Git tags - of the repository. - issue_comment_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - description: A template for the API URL to get information about issue comments - on the repository. - issue_events_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - description: A template for the API URL to get information about issue events - on the repository. - issues_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues{/number} - description: A template for the API URL to get information about issues - on the repository. - keys_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - description: A template for the API URL to get information about deploy - keys on the repository. - labels_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/labels{/name} - description: A template for the API URL to get information about labels - of the repository. - languages_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/languages - description: The API URL to get information about the languages of the repository. - merges_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/merges - description: The API URL to merge branches in the repository. - milestones_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - description: A template for the API URL to get information about milestones - of the repository. - notifications_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - description: A template for the API URL to get information about notifications - on the repository. - pulls_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - description: A template for the API URL to get information about pull requests - on the repository. - releases_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/releases{/id} - description: A template for the API URL to get information about releases - on the repository. - stargazers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/stargazers - description: The API URL to list the stargazers on the repository. - statuses_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - description: A template for the API URL to get information about statuses - of a commit. - subscribers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscribers - description: The API URL to list the subscribers on the repository. - subscription_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscription - description: The API URL to subscribe to notifications for this repository. - tags_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/tags - description: The API URL to get information about tags on the repository. - teams_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/teams - description: The API URL to list the teams on the repository. - trees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - description: A template for the API URL to create or retrieve a raw Git - tree of the repository. - hooks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks - description: The API URL to list the hooks on the repository. - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - nullable: true - dependabot-repository-access-details: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able to access - in an organization - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot updates. - enum: - - public - - internal - example: internal - nullable: true - accessible_repositories: - type: array - items: - "$ref": "#/components/schemas/nullable-simple-repository" - additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -91684,6 +92018,15 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable OIDC subject + claim format. When `true`, OIDC tokens will use a stable, repository-ID-based + `sub` claim. If not set at the repository level, falls back to the organization-level + setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default actions-secret: @@ -134927,6 +135270,219 @@ components: - issue - repository - sender + webhook-issues-field-added: + title: issues field_added event + type: object + properties: + action: + type: string + enum: + - field_added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + issue_field: + type: object + description: The issue field whose value was set or updated on the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was set or updated for the issue field. When + updating an existing value, the previous value is available in `changes`. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, and number + field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present for single_select + field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + changes: + type: object + description: The previous field value, present when an existing value was + updated. + properties: + issue_field_value: + type: object + description: The previous issue field value data. + properties: + from: + type: object + description: The previous value of the issue field before the update. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The previous value. Present for text, date, and + number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the previously selected option. + Present for single_select field types. + option: + type: object + description: The previously selected option details. Present + for single_select field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + required: + - from + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - issue_field + - repository + - sender + webhook-issues-field-removed: + title: issues field_removed event + type: object + properties: + action: + type: string + enum: + - field_removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + issue_field: + type: object + description: The issue field whose value was cleared from the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was cleared from the issue field. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, and number + field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present for single_select + field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - issue_field + - repository + - sender webhook-issues-labeled: title: issues labeled event type: object @@ -215441,6 +215997,78 @@ components: tags_url: https://api.github.com/repos/octo-org/hello-world/tags teams_url: https://api.github.com/repos/octo-org/hello-world/teams trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} + dependabot-repository-access-details: + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks enterprise-teams-items: value: - id: 1 @@ -219189,78 +219817,6 @@ components: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - dependabot-repository-access-details: - value: - default_level: public - accessible_repositories: - - id: 123456 - node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= - name: example-repo - full_name: octocat/example-repo - owner: - name: octocat - email: octo@github.com - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://avatars.githubusercontent.com/u/1?v=4 - gravatar_id: 1 - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat/example-repo - 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 - starred_at: '"2020-07-09T00:17:55Z"' - user_view_type: default - private: false - html_url: https://github.com/octocat/example-repo - description: This is an example repository. - fork: false - url: https://api.github.com/repos/octocat/example-repo - archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} - commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} - compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/example-repo/contributors - deployments_url: https://api.github.com/repos/octocat/example-repo/deployments - downloads_url: https://api.github.com/repos/octocat/example-repo/downloads - events_url: https://api.github.com/repos/octocat/example-repo/events - forks_url: https://api.github.com/repos/octocat/example-repo/forks - git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} - keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} - languages_url: https://api.github.com/repos/octocat/example-repo/languages - merges_url: https://api.github.com/repos/octocat/example-repo/merges - milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} - releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers - statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/example-repo/subscription - tags_url: https://api.github.com/repos/octocat/example-repo/tags - teams_url: https://api.github.com/repos/octocat/example-repo/teams - trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/example-repo/hooks organization-dependabot-secret-paginated: value: total_count: 3 diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 2be99c03f4..a3640142ad 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -4136,6 +4140,236 @@ } } }, + "/enterprises/{enterprise}/dependabot/repository-access": { + "get": { + "summary": "Lists the repositories Dependabot can access in an enterprise", + "description": "Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-repository-access-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-repository-access-details" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an enterprise", + "description": "Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot in an enterprise", + "description": "Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -10607,6 +10841,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -16957,6 +17195,9 @@ "schema": { "type": "object", "additionalProperties": false, + "required": [ + "selected_repository_ids" + ], "properties": { "selected_repository_ids": { "type": "array", @@ -33747,6 +33988,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -37352,6 +37597,11 @@ { "op": "remove", "path": "/requestBody/content/application~1json/schema/properties/return_run_details" + }, + { + "op": "replace", + "path": "/responses/200/description", + "value": "Response including the workflow run ID and URLs." } ], "version": "2026-03-10" @@ -64776,6 +65026,15 @@ }, "assignee": { "$ref": "#/components/schemas/secret-scanning-alert-assignee" + }, + "validity": { + "type": "string", + "nullable": true, + "enum": [ + "active", + "inactive" + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -64842,7 +65101,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -86997,11 +87256,11 @@ } } }, - "issues-labeled": { + "issues-field-added": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue field value was set or updated on an issue.", + "operationId": "issues/field-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87068,7 +87327,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-field-added" } } } @@ -87090,11 +87349,11 @@ } } }, - "issues-locked": { + "issues-field-removed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue field value was cleared from an issue.", + "operationId": "issues/field-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87161,7 +87420,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-field-removed" } } } @@ -87183,11 +87442,11 @@ } } }, - "issues-milestoned": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87254,7 +87513,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -87276,11 +87535,11 @@ } } }, - "issues-opened": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87347,7 +87606,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -87369,11 +87628,11 @@ } } }, - "issues-pinned": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87440,7 +87699,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -87462,11 +87721,11 @@ } } }, - "issues-reopened": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87533,7 +87792,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -87555,11 +87814,11 @@ } } }, - "issues-transferred": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87626,7 +87885,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -87648,11 +87907,11 @@ } } }, - "issues-typed": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was added to an issue.", - "operationId": "issues/typed", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87719,7 +87978,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -87741,11 +88000,11 @@ } } }, - "issues-unassigned": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87812,7 +88071,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -87834,11 +88093,11 @@ } } }, - "issues-unlabeled": { + "issues-typed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87905,7 +88164,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-typed" } } } @@ -87927,11 +88186,11 @@ } } }, - "issues-unlocked": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -87998,7 +88257,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -88020,11 +88279,11 @@ } } }, - "issues-unpinned": { + "issues-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -88091,7 +88350,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -88113,11 +88372,11 @@ } } }, - "issues-untyped": { + "issues-unlocked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was removed from an issue.", - "operationId": "issues/untyped", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -88184,7 +88443,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -88206,13 +88465,13 @@ } } }, - "label-created": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -88234,7 +88493,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "label", + "example": "issues", "schema": { "type": "string" } @@ -88277,7 +88536,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -88290,7 +88549,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -88299,13 +88558,13 @@ } } }, - "label-deleted": { + "issues-untyped": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue type was removed from an issue.", + "operationId": "issues/untyped", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -88327,7 +88586,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "label", + "example": "issues", "schema": { "type": "string" } @@ -88370,7 +88629,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-untyped" } } } @@ -88383,7 +88642,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -88392,11 +88651,11 @@ } } }, - "label-edited": { + "label-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, @@ -88463,7 +88722,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -88485,13 +88744,13 @@ } } }, - "marketplace-purchase-cancelled": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -88513,7 +88772,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "marketplace_purchase", + "example": "label", "schema": { "type": "string" } @@ -88556,7 +88815,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -88569,20 +88828,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -88604,7 +88865,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "marketplace_purchase", + "example": "label", "schema": { "type": "string" } @@ -88647,7 +88908,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -88660,18 +88921,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88738,7 +89001,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -88758,11 +89021,11 @@ } } }, - "marketplace-purchase-pending-change-cancelled": { + "marketplace-purchase-changed": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88829,7 +89092,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -88849,11 +89112,11 @@ } } }, - "marketplace-purchase-purchased": { + "marketplace-purchase-pending-change": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -88920,7 +89183,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -88940,13 +89203,13 @@ } } }, - "member-added": { + "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -88968,7 +89231,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "member", + "example": "marketplace_purchase", "schema": { "type": "string" } @@ -89011,7 +89274,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -89024,23 +89287,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "member-edited": { + "marketplace-purchase-purchased": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -89062,7 +89322,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "member", + "example": "marketplace_purchase", "schema": { "type": "string" } @@ -89105,7 +89365,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" } } } @@ -89118,21 +89378,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "member-removed": { + "member-added": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, @@ -89199,7 +89456,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -89222,13 +89479,13 @@ } } }, - "membership-added": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -89250,7 +89507,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "membership", + "example": "member", "schema": { "type": "string" } @@ -89293,7 +89550,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -89306,22 +89563,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "membership-removed": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -89343,7 +89601,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "membership", + "example": "member", "schema": { "type": "string" } @@ -89386,7 +89644,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -89399,25 +89657,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "merge-group-checks-requested": { + "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -89439,7 +89695,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "merge_group", + "example": "membership", "schema": { "type": "string" } @@ -89482,7 +89738,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -89495,23 +89751,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "membership", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "merge-group-destroyed": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -89533,7 +89788,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "merge_group", + "example": "membership", "schema": { "type": "string" } @@ -89576,7 +89831,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -89589,20 +89844,25 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "membership", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "meta-deleted": { + "merge-group-checks-requested": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -89624,7 +89884,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "meta", + "example": "merge_group", "schema": { "type": "string" } @@ -89667,7 +89927,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -89680,24 +89940,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "merge_group", "supported-webhook-types": [ - "marketplace", - "business", - "repository", - "organization", "app" ] } } }, - "milestone-closed": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -89719,7 +89978,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "milestone", + "example": "merge_group", "schema": { "type": "string" } @@ -89762,7 +90021,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -89775,22 +90034,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "merge_group", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "milestone-created": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -89812,7 +90069,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "milestone", + "example": "meta", "schema": { "type": "string" } @@ -89855,7 +90112,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -89868,8 +90125,10 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "meta", "supported-webhook-types": [ + "marketplace", + "business", "repository", "organization", "app" @@ -89877,11 +90136,11 @@ } } }, - "milestone-deleted": { + "milestone-closed": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -89948,7 +90207,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -89970,11 +90229,11 @@ } } }, - "milestone-edited": { + "milestone-created": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -90041,7 +90300,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -90063,11 +90322,11 @@ } } }, - "milestone-opened": { + "milestone-deleted": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -90134,7 +90393,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -90156,13 +90415,13 @@ } } }, - "org-block-blocked": { + "milestone-edited": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -90184,7 +90443,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "org_block", + "example": "milestone", "schema": { "type": "string" } @@ -90227,7 +90486,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -90240,22 +90499,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "org-block-unblocked": { + "milestone-opened": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -90277,7 +90536,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "org_block", + "example": "milestone", "schema": { "type": "string" } @@ -90320,7 +90579,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -90333,22 +90592,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-deleted": { + "org-block-blocked": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -90370,7 +90629,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "organization", + "example": "org_block", "schema": { "type": "string" } @@ -90413,7 +90672,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-org-block-blocked" } } } @@ -90426,7 +90685,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "org_block", "supported-webhook-types": [ "organization", "business", @@ -90435,13 +90694,13 @@ } } }, - "organization-member-added": { + "org-block-unblocked": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -90463,7 +90722,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "organization", + "example": "org_block", "schema": { "type": "string" } @@ -90506,7 +90765,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -90519,7 +90778,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "org_block", "supported-webhook-types": [ "organization", "business", @@ -90528,11 +90787,11 @@ } } }, - "organization-member-invited": { + "organization-deleted": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90599,7 +90858,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -90621,11 +90880,11 @@ } } }, - "organization-member-removed": { + "organization-member-added": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90692,7 +90951,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -90714,11 +90973,11 @@ } } }, - "organization-renamed": { + "organization-member-invited": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -90785,7 +91044,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -90807,13 +91066,13 @@ } } }, - "package-published": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -90835,7 +91094,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "package", + "example": "organization", "schema": { "type": "string" } @@ -90878,7 +91137,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -90891,21 +91150,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", - "organization" + "organization", + "business", + "app" ] } } }, - "package-updated": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -90927,7 +91187,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "package", + "example": "organization", "schema": { "type": "string" } @@ -90970,7 +91230,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -90983,20 +91243,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", - "organization" + "organization", + "business", + "app" ] } } }, - "page-build": { + "package-published": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -91018,7 +91280,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "page_build", + "example": "package", "schema": { "type": "string" } @@ -91061,7 +91323,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -91074,22 +91336,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "package", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "personal-access-token-request-approved": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was approved.", - "operationId": "personal-access-token-request/approved", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -91101,9 +91362,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -91111,31 +91372,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "package", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -91154,7 +91415,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-package-updated" } } } @@ -91167,21 +91428,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "package", "supported-webhook-types": [ - "app", + "repository", "organization" ] } } }, - "personal-access-token-request-cancelled": { + "page-build": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was cancelled by the requester.", - "operationId": "personal-access-token-request/cancelled", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -91193,9 +91453,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -91203,31 +91463,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "page_build", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -91246,7 +91506,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -91259,19 +91519,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "page_build", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "personal-access-token-request-created": { + "personal-access-token-request-approved": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was created.", - "operationId": "personal-access-token-request/created", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -91338,7 +91599,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -91359,11 +91620,11 @@ } } }, - "personal-access-token-request-denied": { + "personal-access-token-request-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was denied.", - "operationId": "personal-access-token-request/denied", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -91430,7 +91691,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -91451,12 +91712,13 @@ } } }, - "ping": { + "personal-access-token-request-created": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -91468,9 +91730,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -91478,31 +91740,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "ping", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -91521,22 +91783,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-ping" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-ping-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping-form-encoded" - } + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -91548,26 +91795,22 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app", - "business", - "marketplace" + "organization" ] } } }, - "project-card-converted": { + "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -91579,9 +91822,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -91589,31 +91832,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "project_card", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -91632,7 +91875,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -91645,22 +91888,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", - "app" + "app", + "organization" ] } } }, - "project-card-created": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a project (classic).", - "operationId": "project-card/created", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -91682,7 +91923,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project_card", + "example": "ping", "schema": { "type": "string" } @@ -91725,7 +91966,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } } } } @@ -91737,21 +91993,24 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "ping", "supported-webhook-types": [ "repository", "organization", - "app" + "app", + "business", + "marketplace" ] } } }, - "project-card-deleted": { + "project-card-converted": { "post": { "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was deleted.", - "operationId": "project-card/deleted", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, @@ -91818,7 +92077,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -91840,11 +92099,11 @@ } } }, - "project-card-edited": { + "project-card-created": { "post": { "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a project (classic) was edited.", - "operationId": "project-card/edited", + "description": "A card was added to a project (classic).", + "operationId": "project-card/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, @@ -91911,7 +92170,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-project-card-created" } } } @@ -91933,11 +92192,11 @@ } } }, - "project-card-moved": { + "project-card-deleted": { "post": { "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, @@ -92004,7 +92263,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -92026,13 +92285,13 @@ } } }, - "project-closed": { + "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -92054,7 +92313,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project", + "example": "project_card", "schema": { "type": "string" } @@ -92097,7 +92356,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -92110,7 +92369,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -92119,13 +92378,13 @@ } } }, - "project-column-created": { + "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a project (classic).", - "operationId": "project-column/created", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -92147,7 +92406,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project_column", + "example": "project_card", "schema": { "type": "string" } @@ -92190,7 +92449,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -92203,7 +92462,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -92212,11 +92471,104 @@ } } }, - "project-column-deleted": { + "project-closed": { + "post": { + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/closed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-column-created": { "post": { "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a project (classic).", - "operationId": "project-column/deleted", + "description": "A column was added to a project (classic).", + "operationId": "project-column/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, @@ -92283,7 +92635,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -92305,11 +92657,11 @@ } } }, - "project-column-edited": { + "project-column-deleted": { "post": { "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a project (classic) was changed.", - "operationId": "project-column/edited", + "description": "A column was deleted from a project (classic).", + "operationId": "project-column/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, @@ -92376,7 +92728,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -92398,11 +92750,11 @@ } } }, - "project-column-moved": { + "project-column-edited": { "post": { "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a project (classic).", - "operationId": "project-column/moved", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, @@ -92469,7 +92821,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -92491,13 +92843,13 @@ } } }, - "project-created": { + "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was created.", - "operationId": "project/created", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -92519,7 +92871,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project", + "example": "project_column", "schema": { "type": "string" } @@ -92562,7 +92914,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -92575,7 +92927,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -92584,11 +92936,11 @@ } } }, - "project-deleted": { + "project-created": { "post": { "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was deleted.", - "operationId": "project/deleted", + "description": "A project (classic) was created.", + "operationId": "project/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, @@ -92655,7 +93007,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -92677,11 +93029,11 @@ } } }, - "project-edited": { + "project-deleted": { "post": { "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a project (classic) was changed.", - "operationId": "project/edited", + "description": "A project (classic) was deleted.", + "operationId": "project/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, @@ -92748,7 +93100,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -92770,11 +93122,11 @@ } } }, - "project-reopened": { + "project-edited": { "post": { "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/reopened", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, @@ -92841,7 +93193,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -92863,13 +93215,13 @@ } } }, - "projects-v2-closed": { + "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was closed.", - "operationId": "projects-v2/closed", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -92891,7 +93243,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project", "schema": { "type": "string" } @@ -92934,7 +93286,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -92946,20 +93298,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-created": { + "projects-v2-closed": { "post": { "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was created.", - "operationId": "projects-v2/created", + "description": "A project in the organization was closed.", + "operationId": "projects-v2/closed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, @@ -93026,7 +93379,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -93047,11 +93400,11 @@ } } }, - "projects-v2-deleted": { + "projects-v2-created": { "post": { "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was deleted.", - "operationId": "projects-v2/deleted", + "description": "A project in the organization was created.", + "operationId": "projects-v2/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, @@ -93118,7 +93471,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -93139,11 +93492,11 @@ } } }, - "projects-v2-edited": { + "projects-v2-deleted": { "post": { "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The title, description, or README of a project in the organization was changed.", - "operationId": "projects-v2/edited", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, @@ -93210,7 +93563,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -93231,13 +93584,13 @@ } } }, - "projects-v2-item-archived": { + "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -93259,7 +93612,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -93302,7 +93655,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -93316,18 +93669,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-converted": { + "projects-v2-item-archived": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -93394,7 +93747,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -93415,11 +93768,11 @@ } } }, - "projects-v2-item-created": { + "projects-v2-item-converted": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -93486,7 +93839,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -93507,11 +93860,11 @@ } } }, - "projects-v2-item-deleted": { + "projects-v2-item-created": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -93578,7 +93931,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -93599,11 +93952,11 @@ } } }, - "projects-v2-item-edited": { + "projects-v2-item-deleted": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -93670,7 +94023,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -93691,11 +94044,11 @@ } } }, - "projects-v2-item-reordered": { + "projects-v2-item-edited": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -93762,7 +94115,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -93783,11 +94136,11 @@ } } }, - "projects-v2-item-restored": { + "projects-v2-item-reordered": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -93854,7 +94207,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -93875,13 +94228,13 @@ } } }, - "projects-v2-reopened": { + "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was reopened.", - "operationId": "projects-v2/reopened", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -93903,7 +94256,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -93946,7 +94299,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -93960,20 +94313,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-created": { + "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was added to a project in the organization.", - "operationId": "projects-v2-status-update/created", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was reopened.", + "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -93995,7 +94348,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "project-v2", "schema": { "type": "string" } @@ -94038,7 +94391,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -94052,18 +94405,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-deleted": { + "projects-v2-status-update-created": { "post": { "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was removed from a project in the organization.", - "operationId": "projects-v2-status-update/deleted", + "description": "A status update was added to a project in the organization.", + "operationId": "projects-v2-status-update/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, @@ -94130,7 +94483,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" } } } @@ -94151,11 +94504,11 @@ } } }, - "projects-v2-status-update-edited": { + "projects-v2-status-update-deleted": { "post": { "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was edited on a project in the organization.", - "operationId": "projects-v2-status-update/edited", + "description": "A status update was removed from a project in the organization.", + "operationId": "projects-v2-status-update/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, @@ -94222,7 +94575,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" } } } @@ -94243,291 +94596,13 @@ } } }, - "public": { - "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#public" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "public", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-public" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "public", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-assigned": { - "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was assigned to a user.", - "operationId": "pull-request/assigned", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "pull_request", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-auto-merge-disabled": { - "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "pull_request", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-auto-merge-enabled": { + "projects-v2-status-update-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -94549,7 +94624,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -94592,7 +94667,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" } } } @@ -94604,23 +94679,114 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-closed": { + "public": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#public" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "public", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-public" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "public", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-assigned": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -94685,7 +94851,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -94707,11 +94873,11 @@ } } }, - "pull-request-converted-to-draft": { + "pull-request-auto-merge-disabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -94778,7 +94944,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -94800,11 +94966,11 @@ } } }, - "pull-request-demilestoned": { + "pull-request-auto-merge-enabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -94871,7 +95037,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -94893,11 +95059,11 @@ } } }, - "pull-request-dequeued": { + "pull-request-closed": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from the merge queue.", - "operationId": "pull-request/dequeued", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -94964,7 +95130,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -94986,11 +95152,11 @@ } } }, - "pull-request-edited": { + "pull-request-converted-to-draft": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", - "operationId": "pull-request/edited", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -95057,7 +95223,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -95079,11 +95245,11 @@ } } }, - "pull-request-enqueued": { + "pull-request-demilestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to the merge queue.", - "operationId": "pull-request/enqueued", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -95150,7 +95316,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -95172,11 +95338,11 @@ } } }, - "pull-request-labeled": { + "pull-request-dequeued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was added to a pull request.", - "operationId": "pull-request/labeled", + "description": "A pull request was removed from the merge queue.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -95243,7 +95409,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } @@ -95265,11 +95431,11 @@ } } }, - "pull-request-locked": { + "pull-request-edited": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -95336,7 +95502,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -95358,11 +95524,11 @@ } } }, - "pull-request-milestoned": { + "pull-request-enqueued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to a milestone.", - "operationId": "pull-request/milestoned", + "description": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -95429,7 +95595,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } @@ -95451,11 +95617,11 @@ } } }, - "pull-request-opened": { + "pull-request-labeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was created", - "operationId": "pull-request/opened", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -95522,7 +95688,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -95544,11 +95710,11 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-locked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/ready-for-review", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -95615,7 +95781,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -95637,11 +95803,11 @@ } } }, - "pull-request-reopened": { + "pull-request-milestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously closed pull request was reopened.", - "operationId": "pull-request/reopened", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -95708,7 +95874,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -95730,13 +95896,13 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was created.", - "operationId": "pull-request-review-comment/created", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -95758,7 +95924,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request_review_comment", + "example": "pull_request", "schema": { "type": "string" } @@ -95801,7 +95967,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -95814,7 +95980,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -95823,13 +95989,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was deleted.", - "operationId": "pull-request-review-comment/deleted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -95851,7 +96017,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request_review_comment", + "example": "pull_request", "schema": { "type": "string" } @@ -95894,7 +96060,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -95907,7 +96073,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -95916,13 +96082,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The content of a comment on a pull request diff was changed.", - "operationId": "pull-request-review-comment/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -95944,7 +96110,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request_review_comment", + "example": "pull_request", "schema": { "type": "string" } @@ -95987,7 +96153,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -96000,7 +96166,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -96009,13 +96175,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was dismissed.", - "operationId": "pull-request-review/dismissed", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -96037,7 +96203,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request_review", + "example": "pull_request_review_comment", "schema": { "type": "string" } @@ -96080,7 +96246,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -96093,7 +96259,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -96102,13 +96268,13 @@ } } }, - "pull-request-review-edited": { + "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The body comment on a pull request review was edited.", - "operationId": "pull-request-review/edited", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -96130,7 +96296,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request_review", + "example": "pull_request_review_comment", "schema": { "type": "string" } @@ -96173,7 +96339,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -96186,7 +96352,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -96195,13 +96361,13 @@ } } }, - "pull-request-review-request-removed": { + "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A request for review by a person or team was removed from a pull request.", - "operationId": "pull-request/review-request-removed", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -96223,7 +96389,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request", + "example": "pull_request_review_comment", "schema": { "type": "string" } @@ -96266,7 +96432,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -96279,7 +96445,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -96288,13 +96454,13 @@ } } }, - "pull-request-review-requested": { + "pull-request-review-dismissed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", - "operationId": "pull-request/review-requested", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -96316,7 +96482,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request", + "example": "pull_request_review", "schema": { "type": "string" } @@ -96359,7 +96525,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -96372,7 +96538,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -96381,11 +96547,11 @@ } } }, - "pull-request-review-submitted": { + "pull-request-review-edited": { "post": { "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was submitted.", - "operationId": "pull-request-review/submitted", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, @@ -96452,7 +96618,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -96474,13 +96640,13 @@ } } }, - "pull-request-review-thread-resolved": { + "pull-request-review-request-removed": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment thread on a pull request was marked as resolved.", - "operationId": "pull-request-review-thread/resolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -96502,7 +96668,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request_review_thread", + "example": "pull_request", "schema": { "type": "string" } @@ -96545,7 +96711,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -96558,7 +96724,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -96567,13 +96733,13 @@ } } }, - "pull-request-review-thread-unresolved": { + "pull-request-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously resolved comment thread on a pull request was marked as unresolved.", - "operationId": "pull-request-review-thread/unresolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -96595,7 +96761,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request_review_thread", + "example": "pull_request", "schema": { "type": "string" } @@ -96638,7 +96804,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" } } } @@ -96651,7 +96817,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -96660,13 +96826,13 @@ } } }, - "pull-request-synchronize": { + "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -96688,7 +96854,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request", + "example": "pull_request_review", "schema": { "type": "string" } @@ -96731,7 +96897,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -96744,7 +96910,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -96753,13 +96919,13 @@ } } }, - "pull-request-unassigned": { + "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -96781,7 +96947,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request", + "example": "pull_request_review_thread", "schema": { "type": "string" } @@ -96824,7 +96990,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" } } } @@ -96837,7 +97003,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -96846,13 +97012,13 @@ } } }, - "pull-request-unlabeled": { + "pull-request-review-thread-unresolved": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -96874,7 +97040,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "pull_request", + "example": "pull_request_review_thread", "schema": { "type": "string" } @@ -96917,7 +97083,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" } } } @@ -96930,7 +97096,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -96939,11 +97105,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -97010,7 +97176,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -97032,12 +97198,13 @@ } } }, - "push": { + "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -97059,7 +97226,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -97102,7 +97269,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -97115,7 +97282,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -97124,13 +97291,13 @@ } } }, - "registry-package-published": { + "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -97152,7 +97319,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "registry_package", + "example": "pull_request", "schema": { "type": "string" } @@ -97195,7 +97362,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -97208,7 +97375,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -97217,13 +97384,13 @@ } } }, - "registry-package-updated": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -97245,7 +97412,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "registry_package", + "example": "pull_request", "schema": { "type": "string" } @@ -97288,7 +97455,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -97301,7 +97468,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -97310,13 +97477,12 @@ } } }, - "release-created": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -97338,7 +97504,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "push", "schema": { "type": "string" } @@ -97381,7 +97547,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-push" } } } @@ -97394,7 +97560,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -97403,13 +97569,13 @@ } } }, - "release-deleted": { + "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -97431,7 +97597,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -97474,7 +97640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -97487,7 +97653,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -97496,13 +97662,13 @@ } } }, - "release-edited": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -97524,7 +97690,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -97567,7 +97733,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -97580,7 +97746,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -97589,11 +97755,11 @@ } } }, - "release-prereleased": { + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -97660,7 +97826,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -97682,11 +97848,11 @@ } } }, - "release-published": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -97753,7 +97919,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -97775,11 +97941,11 @@ } } }, - "release-released": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -97846,7 +98012,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -97868,11 +98034,11 @@ } } }, - "release-unpublished": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -97939,7 +98105,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -97961,13 +98127,13 @@ } } }, - "repository-advisory-published": { + "release-published": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -97989,7 +98155,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -98032,7 +98198,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -98045,7 +98211,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -98054,13 +98220,13 @@ } } }, - "repository-advisory-reported": { + "release-released": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -98082,7 +98248,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -98125,7 +98291,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -98138,7 +98304,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -98147,13 +98313,13 @@ } } }, - "repository-archived": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -98175,7 +98341,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "release", "schema": { "type": "string" } @@ -98218,7 +98384,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -98231,9 +98397,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -98241,13 +98406,13 @@ } } }, - "repository-created": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -98269,11 +98434,104 @@ { "name": "X-Github-Event", "in": "header", + "example": "repository_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", "example": "repository", "schema": { "type": "string" } }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-advisory-published" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_advisory", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-advisory-reported": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_advisory", + "schema": { + "type": "string" + } + }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", @@ -98312,7 +98570,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -98325,9 +98583,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -98335,11 +98592,11 @@ } } }, - "repository-deleted": { + "repository-archived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -98406,7 +98663,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -98429,12 +98686,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-created": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -98456,7 +98714,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_dispatch", + "example": "repository", "schema": { "type": "string" } @@ -98499,7 +98757,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -98512,18 +98770,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-deleted": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -98590,7 +98851,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -98613,12 +98874,12 @@ } } }, - "repository-import": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -98640,7 +98901,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_import", + "example": "repository_dispatch", "schema": { "type": "string" } @@ -98683,7 +98944,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -98696,19 +98957,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "repository", - "organization" + "app" ] } } }, - "repository-privatized": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -98775,7 +99035,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -98798,13 +99058,12 @@ } } }, - "repository-publicized": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -98826,7 +99085,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_import", "schema": { "type": "string" } @@ -98869,7 +99128,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -98882,21 +99141,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-renamed": { + "repository-privatized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -98963,7 +99220,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -98986,13 +99243,13 @@ } } }, - "repository-ruleset-created": { + "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -99014,7 +99271,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -99057,7 +99314,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -99070,8 +99327,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -99079,13 +99337,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -99107,7 +99365,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -99150,7 +99408,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -99163,8 +99421,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -99172,11 +99431,11 @@ } } }, - "repository-ruleset-edited": { + "repository-ruleset-created": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -99243,7 +99502,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -99265,13 +99524,13 @@ } } }, - "repository-transferred": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -99293,7 +99552,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_ruleset", "schema": { "type": "string" } @@ -99336,7 +99595,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -99349,9 +99608,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -99359,13 +99617,13 @@ } } }, - "repository-unarchived": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -99387,7 +99645,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_ruleset", "schema": { "type": "string" } @@ -99430,7 +99688,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -99443,9 +99701,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -99453,13 +99710,13 @@ } } }, - "repository-vulnerability-alert-create": { + "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -99481,7 +99738,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "repository", "schema": { "type": "string" } @@ -99524,7 +99781,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -99537,21 +99794,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-dismiss": { + "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -99573,7 +99832,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "repository", "schema": { "type": "string" } @@ -99616,7 +99875,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -99629,19 +99888,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-create": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -99708,7 +99969,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -99729,11 +99990,11 @@ } } }, - "repository-vulnerability-alert-resolve": { + "repository-vulnerability-alert-dismiss": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -99800,7 +100061,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -99821,13 +100082,13 @@ } } }, - "secret-scanning-alert-assigned": { + "repository-vulnerability-alert-reopen": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was assigned.", - "operationId": "secret-scanning-alert/assigned", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -99849,7 +100110,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -99892,7 +100153,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -99905,22 +100166,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-created": { + "repository-vulnerability-alert-resolve": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -99942,7 +100202,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -99985,7 +100245,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -99998,22 +100258,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -100035,7 +100294,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -100078,22 +100337,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -100105,9 +100349,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -100116,11 +100359,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -100187,7 +100430,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -100209,13 +100452,13 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -100237,7 +100480,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -100280,7 +100523,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } } } } @@ -100292,8 +100550,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -100302,11 +100561,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-publicly-leaked": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -100373,7 +100632,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -100395,11 +100654,11 @@ } } }, - "secret-scanning-alert-unassigned": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was unassigned.", - "operationId": "secret-scanning-alert/unassigned", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -100466,7 +100725,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -100488,11 +100747,11 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was validated.", - "operationId": "secret-scanning-alert/validated", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -100559,7 +100818,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -100581,13 +100840,13 @@ } } }, - "secret-scanning-scan-completed": { + "secret-scanning-alert-unassigned": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning scan was completed.", - "operationId": "secret-scanning-scan/completed", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -100609,7 +100868,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -100652,7 +100911,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -100665,7 +100924,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -100674,13 +100933,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -100702,7 +100961,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -100745,7 +101004,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -100758,18 +101017,113 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-scan-completed": { + "post": { + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_scan", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_scan", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "security-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, @@ -100836,7 +101190,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -100856,11 +101210,11 @@ } } }, - "security-advisory-withdrawn": { + "security-advisory-updated": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, @@ -100927,7 +101281,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -100947,12 +101301,13 @@ } } }, - "security-and-analysis": { + "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -100974,7 +101329,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "security_advisory", "schema": { "type": "string" } @@ -101017,7 +101372,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -101030,22 +101385,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "sponsorship-cancelled": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -101067,7 +101419,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_and_analysis", "schema": { "type": "string" } @@ -101110,7 +101462,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -101123,18 +101475,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_and_analysis", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-created": { + "sponsorship-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -101201,7 +101555,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -101221,11 +101575,11 @@ } } }, - "sponsorship-edited": { + "sponsorship-created": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -101292,7 +101646,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -101312,11 +101666,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-edited": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -101383,7 +101737,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -101403,11 +101757,11 @@ } } }, - "sponsorship-pending-tier-change": { + "sponsorship-pending-cancellation": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -101474,7 +101828,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -101494,11 +101848,11 @@ } } }, - "sponsorship-tier-changed": { + "sponsorship-pending-tier-change": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -101565,7 +101919,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -101585,13 +101939,13 @@ } } }, - "star-created": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -101613,7 +101967,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -101656,7 +102010,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -101669,20 +102023,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "star-created": { "post": { "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, @@ -101749,7 +102101,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -101771,12 +102123,13 @@ } } }, - "status": { + "star-deleted": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -101798,7 +102151,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "star", "schema": { "type": "string" } @@ -101841,7 +102194,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -101854,7 +102207,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -101863,13 +102216,12 @@ } } }, - "sub-issues-parent-issue-added": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was added to an issue.", - "operationId": "sub-issues/parent-issue-added", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -101891,7 +102243,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "status", "schema": { "type": "string" } @@ -101934,7 +102286,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-status" } } } @@ -101947,7 +102299,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -101956,11 +102308,11 @@ } } }, - "sub-issues-parent-issue-removed": { + "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was removed from an issue.", - "operationId": "sub-issues/parent-issue-removed", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -102027,7 +102379,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -102049,11 +102401,11 @@ } } }, - "sub-issues-sub-issue-added": { + "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was added to an issue.", - "operationId": "sub-issues/sub-issue-added", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -102120,7 +102472,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -102142,11 +102494,11 @@ } } }, - "sub-issues-sub-issue-removed": { + "sub-issues-sub-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was removed from an issue.", - "operationId": "sub-issues/sub-issue-removed", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -102213,7 +102565,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -102235,12 +102587,13 @@ } } }, - "team-add": { + "sub-issues-sub-issue-removed": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -102262,7 +102615,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -102305,7 +102658,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -102318,7 +102671,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -102327,13 +102680,12 @@ } } }, - "team-added-to-repository": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -102355,7 +102707,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "team_add", "schema": { "type": "string" } @@ -102398,7 +102750,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -102411,20 +102763,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "team_add", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "team-added-to-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -102491,7 +102843,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -102513,11 +102865,11 @@ } } }, - "team-deleted": { + "team-created": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team was created.", + "operationId": "team/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -102584,7 +102936,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -102606,11 +102958,11 @@ } } }, - "team-edited": { + "team-deleted": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "description": "A team was deleted.", + "operationId": "team/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -102677,7 +103029,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -102699,11 +103051,11 @@ } } }, - "team-removed-from-repository": { + "team-edited": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team's access to a repository was removed.", - "operationId": "team/removed-from-repository", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -102770,7 +103122,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -102792,13 +103144,13 @@ } } }, - "watch-started": { + "team-removed-from-repository": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone started watching the repository.", - "operationId": "watch/started", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team's access to a repository was removed.", + "operationId": "team/removed-from-repository", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -102820,7 +103172,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -102863,7 +103215,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -102876,206 +103228,299 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "team", "supported-webhook-types": [ - "repository", "organization", - "app" - ] - } - } - }, - "workflow-dispatch": { - "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "workflow_dispatch", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "workflow_dispatch", - "supported-webhook-types": [ - "app" - ] - } - } - }, - "workflow-job-completed": { - "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "workflow_job", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "workflow_job", - "supported-webhook-types": [ "business", - "repository", - "organization", "app" ] } } }, - "workflow-job-in-progress": { + "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone started watching the repository.", + "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "watch", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-watch-started" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "watch", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-dispatch": { + "post": { + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_dispatch", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-dispatch" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "workflow-job-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -108568,6 +109013,329 @@ ], "additionalProperties": false }, + "nullable-simple-repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "nullable": true + }, + "dependabot-repository-access-details": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true + }, + "accessible_repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/nullable-simple-repository" + } + } + }, + "additionalProperties": false + }, "enterprise-team": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", @@ -114103,6 +114871,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -116365,329 +117137,6 @@ ], "additionalProperties": true }, - "nullable-simple-repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ], - "nullable": true - }, - "dependabot-repository-access-details": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", - "type": "object", - "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal", - "nullable": true - }, - "accessible_repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/nullable-simple-repository" - } - } - }, - "additionalProperties": false - }, "organization-dependabot-secret": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", @@ -126438,6 +126887,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -184295,6 +184752,306 @@ "sender" ] }, + "webhook-issues-field-added": { + "title": "issues field_added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "field_added" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was set or updated on the issue.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "field_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was set or updated for the issue field. When updating an existing value, the previous value is available in `changes`.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + }, + "changes": { + "type": "object", + "description": "The previous field value, present when an existing value was updated.", + "properties": { + "issue_field_value": { + "type": "object", + "description": "The previous issue field value data.", + "properties": { + "from": { + "type": "object", + "description": "The previous value of the issue field before the update.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The previous value. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the previously selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The previously selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "from" + ] + } + } + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "issue_field", + "repository", + "sender" + ] + }, + "webhook-issues-field-removed": { + "title": "issues field_removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "field_removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was cleared from the issue.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "field_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was cleared from the issue field.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "issue_field", + "repository", + "sender" + ] + }, "webhook-issues-labeled": { "title": "issues labeled event", "type": "object", @@ -290923,6 +291680,84 @@ } ] }, + "dependabot-repository-access-details": { + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } + }, "enterprise-teams-items": { "value": [ { @@ -295371,84 +296206,6 @@ } ] }, - "dependabot-repository-access-details": { - "value": { - "default_level": "public", - "accessible_repositories": [ - { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", - "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, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" - }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" - } - ] - } - }, "organization-dependabot-secret-paginated": { "value": { "total_count": 3, diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 39e4b63ca7..ccbde1189a 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -73,6 +73,9 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot @@ -2999,6 +3002,179 @@ paths: previews: [] category: dependabot subcategory: alerts + "/enterprises/{enterprise}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an enterprise + description: |- + Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/dependabot-repository-access-details" + examples: + default: + "$ref": "#/components/examples/dependabot-repository-access-details" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an enterprise + description: |- + Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + "/enterprises/{enterprise}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot in an enterprise + description: |- + Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -7602,6 +7778,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -12296,6 +12478,8 @@ paths: schema: type: object additionalProperties: false + required: + - selected_repository_ids properties: selected_repository_ids: type: array @@ -24587,6 +24771,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -27135,6 +27324,9 @@ paths: path: "/responses/204" - op: remove path: "/requestBody/content/application~1json/schema/properties/return_run_details" + - op: replace + path: "/responses/200/description" + value: Response including the workflow run ID and URLs. version: '2026-03-10' "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": put: @@ -47088,6 +47280,14 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" assignee: "$ref": "#/components/schemas/secret-scanning-alert-assignee" + validity: + type: string + nullable: true + enum: + - active + - inactive + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -47126,7 +47326,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -62930,7 +63131,7 @@ x-webhooks: - repository - organization - app - issues-labeled: + issues-field-added: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -62938,8 +63139,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue field value was set or updated on an issue. + operationId: issues/field-added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -62983,7 +63184,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-field-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62996,7 +63197,7 @@ x-webhooks: - repository - organization - app - issues-locked: + issues-field-removed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63004,9 +63205,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue field value was cleared from an issue. + operationId: issues/field-removed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63050,7 +63250,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-field-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63063,7 +63263,7 @@ x-webhooks: - repository - organization - app - issues-milestoned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63071,8 +63271,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63116,7 +63316,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63129,7 +63329,7 @@ x-webhooks: - repository - organization - app - issues-opened: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63137,9 +63337,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63183,7 +63383,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63196,7 +63396,7 @@ x-webhooks: - repository - organization - app - issues-pinned: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63204,9 +63404,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63250,7 +63449,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63263,7 +63462,7 @@ x-webhooks: - repository - organization - app - issues-reopened: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63271,8 +63470,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63316,7 +63516,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63329,7 +63529,7 @@ x-webhooks: - repository - organization - app - issues-transferred: + issues-pinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63337,9 +63537,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63383,7 +63583,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63396,7 +63596,7 @@ x-webhooks: - repository - organization - app - issues-typed: + issues-reopened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63404,8 +63604,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: A closed issue was reopened. + operationId: issues/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63449,7 +63649,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63462,7 +63662,7 @@ x-webhooks: - repository - organization - app - issues-unassigned: + issues-transferred: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63470,8 +63670,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63515,7 +63716,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63528,7 +63729,7 @@ x-webhooks: - repository - organization - app - issues-unlabeled: + issues-typed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63536,8 +63737,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63581,7 +63782,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63594,7 +63795,7 @@ x-webhooks: - repository - organization - app - issues-unlocked: + issues-unassigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63602,9 +63803,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked + description: A user was unassigned from an issue. + operationId: issues/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63648,7 +63848,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63661,7 +63861,7 @@ x-webhooks: - repository - organization - app - issues-unpinned: + issues-unlabeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63669,9 +63869,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned + description: A label was removed from an issue. + operationId: issues/unlabeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63715,7 +63914,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63728,7 +63927,7 @@ x-webhooks: - repository - organization - app - issues-untyped: + issues-unlocked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -63736,8 +63935,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was removed from an issue. - operationId: issues/untyped + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -63781,7 +63981,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-issues-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63794,18 +63994,19 @@ x-webhooks: - repository - organization - app - label-created: + issues-unpinned: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was created. - operationId: label/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was unpinned from a repository. For more information, + see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -63819,7 +64020,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: label + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63847,7 +64048,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63855,23 +64056,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-deleted: + issues-untyped: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was deleted. - operationId: label/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was removed from an issue. + operationId: issues/untyped externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -63885,7 +64086,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: label + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -63913,7 +64114,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-untyped" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63921,12 +64122,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-edited: + label-created: post: summary: |- This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. @@ -63934,8 +64135,8 @@ x-webhooks: If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label's name, description, or color was changed. - operationId: label/edited + description: A label was created. + operationId: label/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: @@ -63979,7 +64180,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63992,19 +64193,18 @@ x-webhooks: - repository - organization - app - marketplace-purchase-cancelled: + label-deleted: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a GitHub Marketplace plan, and the last billing - cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/cancelled + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was deleted. + operationId: label/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -64018,7 +64218,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: marketplace_purchase + example: label schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64046,7 +64246,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64054,22 +64254,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: label supported-webhook-types: - - marketplace - marketplace-purchase-changed: + - repository + - organization + - app + label-edited: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone upgraded or downgraded a GitHub Marketplace plan, and the - last billing cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/changed + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label's name, description, or color was changed. + operationId: label/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -64083,7 +64284,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: marketplace_purchase + example: label schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64111,7 +64312,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-label-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64119,10 +64320,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: label supported-webhook-types: - - marketplace - marketplace-purchase-pending-change: + - repository + - organization + - app + marketplace-purchase-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -64130,11 +64333,9 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone downgraded or cancelled a GitHub Marketplace plan. The - new plan or cancellation will take effect at the end of the current billing - cycle. When the change takes effect, the `changed` or `cancelled` event will - be sent. - operationId: marketplace-purchase/pending-change + description: Someone cancelled a GitHub Marketplace plan, and the last billing + cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -64178,7 +64379,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64189,7 +64390,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-pending-change-cancelled: + marketplace-purchase-changed: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -64197,10 +64398,9 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone cancelled a pending change to a GitHub Marketplace plan. - Pending changes include plan cancellations and downgrades that will take effect - at the end of a billing cycle. - operationId: marketplace-purchase/pending-change-cancelled + description: Someone upgraded or downgraded a GitHub Marketplace plan, and the + last billing cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/changed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -64244,7 +64444,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64255,7 +64455,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-purchased: + marketplace-purchase-pending-change: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." @@ -64263,9 +64463,11 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in the REST API documentation. - description: Someone purchased a GitHub Marketplace plan. The change will take - effect on the account immediately. - operationId: marketplace-purchase/purchased + description: Someone downgraded or cancelled a GitHub Marketplace plan. The + new plan or cancellation will take effect at the end of the current billing + cycle. When the change takes effect, the `changed` or `cancelled` event will + be sent. + operationId: marketplace-purchase/pending-change externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -64309,7 +64511,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64320,16 +64522,20 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - member-added: + marketplace-purchase-pending-change-cancelled: post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A GitHub user accepted an invitation to a repository. - operationId: member/added + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone cancelled a pending change to a GitHub Marketplace plan. + Pending changes include plan cancellations and downgrades that will take effect + at the end of a billing cycle. + operationId: marketplace-purchase/pending-change-cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -64343,7 +64549,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: member + example: marketplace_purchase schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64371,7 +64577,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64379,22 +64585,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: marketplace_purchase supported-webhook-types: - - business - - repository - - organization - - app - member-edited: + - marketplace + marketplace-purchase-purchased: post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: Permissions were changed for a collaborator on a repository. - operationId: member/edited + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone purchased a GitHub Marketplace plan. The change will take + effect on the account immediately. + operationId: marketplace-purchase/purchased externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -64408,7 +64614,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: member + example: marketplace_purchase schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64436,7 +64642,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64444,20 +64650,17 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: marketplace_purchase supported-webhook-types: - - business - - repository - - organization - - app - member-removed: + - marketplace + member-added: post: summary: |- This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A collaborator was removed from a repository. - operationId: member/removed + description: A GitHub user accepted an invitation to a repository. + operationId: member/added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: @@ -64501,7 +64704,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64515,16 +64718,16 @@ x-webhooks: - repository - organization - app - membership-added: + member-edited: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was added to a team. - operationId: membership/added + description: Permissions were changed for a collaborator on a repository. + operationId: member/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -64538,7 +64741,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: membership + example: member schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -64566,7 +64769,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-member-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64574,21 +64777,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: member supported-webhook-types: - - organization - business + - repository + - organization - app - membership-removed: + member-removed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was removed from a team. - operationId: membership/removed + description: A collaborator was removed from a repository. + operationId: member/removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -64602,7 +64806,136 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: membership + example: member + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-member-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: member + supported-webhook-types: + - business + - repository + - organization + - app + membership-added: + post: + summary: |- + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was added to a team. + operationId: membership/added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: membership + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-membership-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: membership + supported-webhook-types: + - organization + - business + - app + membership-removed: + post: + summary: |- + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was removed from a team. + operationId: membership/removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: membership schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -78829,6 +79162,298 @@ components: - fixed_at - repository additionalProperties: false + nullable-simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the + GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an + archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees + for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git + blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches + in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators + of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments + on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits + on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits + of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs + of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags + of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events + on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues + on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy + keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels + of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones + of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications + on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests + on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases + on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses + of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git + tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + nullable: true + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able to access + in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + "$ref": "#/components/schemas/nullable-simple-repository" + additionalProperties: false enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -83076,6 +83701,11 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim format + for the organization. When `true`, new OIDC tokens will use a stable, + repository-ID-based `sub` claim instead of the name-based format. + type: boolean required: - include_claim_keys empty-object: @@ -84946,298 +85576,6 @@ components: required: - date additionalProperties: true - nullable-simple-repository: - title: Simple Repository - description: A GitHub repository. - type: object - properties: - id: - type: integer - format: int64 - example: 1296269 - description: A unique identifier of the repository. - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - description: The GraphQL identifier of the repository. - name: - type: string - example: Hello-World - description: The name of the repository. - full_name: - type: string - example: octocat/Hello-World - description: The full, globally unique, name of the repository. - owner: - "$ref": "#/components/schemas/simple-user" - private: - type: boolean - description: Whether the repository is private. - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: The URL to view the repository on GitHub.com. - description: - type: string - example: This your first repo! - nullable: true - description: The repository description. - fork: - type: boolean - description: Whether the repository is a fork. - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - description: The URL to get more information about the repository from the - GitHub API. - archive_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - description: A template for the API URL to download the repository as an - archive. - assignees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - description: A template for the API URL to list the available assignees - for issues in the repository. - blobs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - description: A template for the API URL to create or retrieve a raw Git - blob in the repository. - branches_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - description: A template for the API URL to get information about branches - in the repository. - collaborators_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - description: A template for the API URL to get information about collaborators - of the repository. - comments_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/comments{/number} - description: A template for the API URL to get information about comments - on the repository. - commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - description: A template for the API URL to get information about commits - on the repository. - compare_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - description: A template for the API URL to compare two commits or refs. - contents_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - description: A template for the API URL to get the contents of the repository. - contributors_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/contributors - description: A template for the API URL to list the contributors to the - repository. - deployments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/deployments - description: The API URL to list the deployments of the repository. - downloads_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/downloads - description: The API URL to list the downloads on the repository. - events_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/events - description: The API URL to list the events of the repository. - forks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/forks - description: The API URL to list the forks of the repository. - git_commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - description: A template for the API URL to get information about Git commits - of the repository. - git_refs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - description: A template for the API URL to get information about Git refs - of the repository. - git_tags_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - description: A template for the API URL to get information about Git tags - of the repository. - issue_comment_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - description: A template for the API URL to get information about issue comments - on the repository. - issue_events_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - description: A template for the API URL to get information about issue events - on the repository. - issues_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues{/number} - description: A template for the API URL to get information about issues - on the repository. - keys_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - description: A template for the API URL to get information about deploy - keys on the repository. - labels_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/labels{/name} - description: A template for the API URL to get information about labels - of the repository. - languages_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/languages - description: The API URL to get information about the languages of the repository. - merges_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/merges - description: The API URL to merge branches in the repository. - milestones_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - description: A template for the API URL to get information about milestones - of the repository. - notifications_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - description: A template for the API URL to get information about notifications - on the repository. - pulls_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - description: A template for the API URL to get information about pull requests - on the repository. - releases_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/releases{/id} - description: A template for the API URL to get information about releases - on the repository. - stargazers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/stargazers - description: The API URL to list the stargazers on the repository. - statuses_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - description: A template for the API URL to get information about statuses - of a commit. - subscribers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscribers - description: The API URL to list the subscribers on the repository. - subscription_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscription - description: The API URL to subscribe to notifications for this repository. - tags_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/tags - description: The API URL to get information about tags on the repository. - teams_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/teams - description: The API URL to list the teams on the repository. - trees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - description: A template for the API URL to create or retrieve a raw Git - tree of the repository. - hooks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks - description: The API URL to list the hooks on the repository. - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - nullable: true - dependabot-repository-access-details: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able to access - in an organization - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot updates. - enum: - - public - - internal - example: internal - nullable: true - accessible_repositories: - type: array - items: - "$ref": "#/components/schemas/nullable-simple-repository" - additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -92931,6 +93269,15 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable OIDC subject + claim format. When `true`, OIDC tokens will use a stable, repository-ID-based + `sub` claim. If not set at the repository level, falls back to the organization-level + setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default actions-secret: @@ -136338,6 +136685,219 @@ components: - issue - repository - sender + webhook-issues-field-added: + title: issues field_added event + type: object + properties: + action: + type: string + enum: + - field_added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + issue_field: + type: object + description: The issue field whose value was set or updated on the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was set or updated for the issue field. When + updating an existing value, the previous value is available in `changes`. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, and number + field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present for single_select + field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + changes: + type: object + description: The previous field value, present when an existing value was + updated. + properties: + issue_field_value: + type: object + description: The previous issue field value data. + properties: + from: + type: object + description: The previous value of the issue field before the update. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The previous value. Present for text, date, and + number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the previously selected option. + Present for single_select field types. + option: + type: object + description: The previously selected option details. Present + for single_select field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + required: + - from + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - issue_field + - repository + - sender + webhook-issues-field-removed: + title: issues field_removed event + type: object + properties: + action: + type: string + enum: + - field_removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + issue_field: + type: object + description: The issue field whose value was cleared from the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was cleared from the issue field. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, and number + field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present for single_select + field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - issue_field + - repository + - sender webhook-issues-labeled: title: issues labeled event type: object @@ -217498,6 +218058,78 @@ components: tags_url: https://api.github.com/repos/octo-org/hello-world/tags teams_url: https://api.github.com/repos/octo-org/hello-world/teams trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} + dependabot-repository-access-details: + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks enterprise-teams-items: value: - id: 1 @@ -221260,78 +221892,6 @@ components: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - dependabot-repository-access-details: - value: - default_level: public - accessible_repositories: - - id: 123456 - node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= - name: example-repo - full_name: octocat/example-repo - owner: - name: octocat - email: octo@github.com - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://avatars.githubusercontent.com/u/1?v=4 - gravatar_id: 1 - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat/example-repo - 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 - starred_at: '"2020-07-09T00:17:55Z"' - user_view_type: default - private: false - html_url: https://github.com/octocat/example-repo - description: This is an example repository. - fork: false - url: https://api.github.com/repos/octocat/example-repo - archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} - commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} - compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/example-repo/contributors - deployments_url: https://api.github.com/repos/octocat/example-repo/deployments - downloads_url: https://api.github.com/repos/octocat/example-repo/downloads - events_url: https://api.github.com/repos/octocat/example-repo/events - forks_url: https://api.github.com/repos/octocat/example-repo/forks - git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} - keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} - languages_url: https://api.github.com/repos/octocat/example-repo/languages - merges_url: https://api.github.com/repos/octocat/example-repo/merges - milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} - releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers - statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/example-repo/subscription - tags_url: https://api.github.com/repos/octocat/example-repo/tags - teams_url: https://api.github.com/repos/octocat/example-repo/teams - trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/example-repo/hooks organization-dependabot-secret-paginated: value: total_count: 3 diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index bd38039225..350e8fd7f0 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -24956,17 +24960,17 @@ } } }, - "/enterprises/{enterprise}/teams": { + "/enterprises/{enterprise}/dependabot/repository-access": { "get": { - "summary": "List enterprise teams", - "description": "List all teams in the enterprise for the authenticated user", + "summary": "Lists the repositories Dependabot can access in an enterprise", + "description": "Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", "tags": [ - "enterprise-teams" + "dependabot" ], - "operationId": "enterprise-teams/list", + "operationId": "dependabot/repository-access-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" }, "parameters": [ { @@ -24979,21 +24983,26 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "page", "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { "type": "integer", - "default": 30 + "minimum": 1, + "default": 1 } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "per_page", "in": "query", + "description": "Number of results per page.", + "required": false, "schema": { "type": "integer", - "default": 1 + "minimum": 1, + "maximum": 100, + "default": 30 } } ], @@ -25003,106 +25012,1000 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "example": "disabled | all" - }, - "organization_selection_type": { - "type": "string", - "example": "disabled | selected | all" - }, - "group_id": { - "nullable": true, - "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "group_name": { - "nullable": true, - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "example": "Justice League" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/dc/teams/justice-league" - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" - ] - } + "accessible_repositories": { + "type": "array", + "items": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "nullable": true + } + } + }, + "additionalProperties": false }, "examples": { "default": { - "value": [ - { - "id": 1, - "name": "Justice League", - "description": "A great team.", - "slug": "justice-league", - "url": "https://api.github.com/enterprises/dc/teams/justice-league", - "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", - "html_url": "https://github.com/enterprises/dc/teams/justice-league", - "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", - "created_at": "2019-01-26T19:01:12Z", - "updated_at": "2019-01-26T19:14:43Z" - } - ] + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an enterprise", + "description": "Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot in an enterprise", + "description": "Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/teams": { + "get": { + "summary": "List enterprise teams", + "description": "List all teams in the enterprise for the authenticated user", + "tags": [ + "enterprise-teams" + ], + "operationId": "enterprise-teams/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "example": "disabled | all" + }, + "organization_selection_type": { + "type": "string", + "example": "disabled | selected | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" + }, + "group_name": { + "nullable": true, + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "example": "Justice League" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Justice League", + "description": "A great team.", + "slug": "justice-league", + "url": "https://api.github.com/enterprises/dc/teams/justice-league", + "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", + "html_url": "https://github.com/enterprises/dc/teams/justice-league", + "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", + "created_at": "2019-01-26T19:01:12Z", + "updated_at": "2019-01-26T19:14:43Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, "403": { @@ -77633,6 +78536,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -77696,6 +78603,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -100203,6 +101114,9 @@ "schema": { "type": "object", "additionalProperties": false, + "required": [ + "selected_repository_ids" + ], "properties": { "selected_repository_ids": { "type": "array", @@ -231354,6 +232268,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -231521,6 +232443,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -530447,6 +531373,15 @@ "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", "type": "string", "nullable": true + }, + "validity": { + "type": "string", + "nullable": true, + "enum": [ + "active", + "inactive" + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -531694,7 +532629,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "description": "Service unavailable", @@ -940496,567 +941431,8141 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "type": "object", + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-demilestoned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues demilestoned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "demilestoned" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "pinned_at", - "pinned_by" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" ], - "nullable": true + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ "id", "node_id", + "owner", + "name", + "description", + "external_url", "html_url", - "issue_url", - "user", - "url", "created_at", - "updated_at" - ], - "nullable": true + "updated_at", + "permissions", + "events" + ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "total": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { "type": "integer" }, - "completed": { + "+1": { "type": "integer" }, - "percent_completed": { + "-1": { "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { + }, + "laugh": { "type": "integer" }, - "blocking": { + "confused": { "type": "integer" }, - "total_blocked_by": { + "heart": { "type": "integer" }, - "total_blocking": { + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { "type": "integer" } }, "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", + "pin": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", + "id": { + "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, - "node_id": { + "name": { + "description": "The name of the option", "type": "string", - "example": "IFT_GDKND" + "example": "High" }, - "data_type": { - "description": "The data type of the issue field", + "color": { + "description": "The color of the option", "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true + "example": "red" } }, "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] + "id", + "name", + "color" + ], + "nullable": true } }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "state_reason": { + "node_id": { "type": "string", - "nullable": true + "description": "The node identifier of the issue type." }, - "timeline_url": { + "name": { "type": "string", - "format": "uri" + "description": "The name of the issue type." }, - "title": { - "description": "Title of the issue", - "type": "string" + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, - "updated_at": { + "created_at": { "type": "string", + "description": "The time the issue type created.", "format": "date-time" }, - "url": { - "description": "URL for the issue", + "updated_at": { "type": "string", - "format": "uri" + "description": "The time the issue type last updated.", + "format": "date-time" }, - "user": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "name", + "description" ] }, - { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "active_lock_reason": { + "avatar_url": { "type": "string", - "nullable": true + "format": "uri" }, - "assignee": { - "type": "object", - "nullable": true + "deleted": { + "type": "boolean" }, - "assignees": { - "type": "array", - "items": { - "type": "object", - "nullable": true - } + "email": { + "type": "string", + "nullable": true }, - "author_association": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "body": { + "followers_url": { "type": "string", - "nullable": true + "format": "uri" }, - "closed_at": { + "following_url": { "type": "string", - "nullable": true + "format": "uri-template" }, - "comments": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "comments_url": { + "gravatar_id": { "type": "string" }, - "created_at": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, - "events_url": { + "name": { "type": "string" }, - "html_url": { + "node_id": { "type": "string" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "labels": { - "type": "array", - "items": { - "type": "object", - "nullable": true - } + "received_events_url": { + "type": "string", + "format": "uri" }, - "labels_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "locked": { + "site_admin": { "type": "boolean" }, - "milestone": { - "type": "object", - "nullable": true + "starred_url": { + "type": "string", + "format": "uri-template" }, - "node_id": { + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { "type": "string" + } + } + } + } + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "number": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "performed_via_github_app": { - "type": "object", + "email": { + "type": "string", "nullable": true }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } + "events_url": { + "type": "string", + "format": "uri-template" }, - "repository_url": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "state": { + "html_url": { "type": "string", - "enum": [ - "closed", - "open" - ] + "format": "uri" }, - "timeline_url": { + "id": { + "type": "integer" + }, + "login": { "type": "string" }, - "title": { + "name": { "type": "string" }, - "updated_at": { + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user_view_type": { - "type": "string" - } - } + "user_view_type": { + "type": "string" } }, "required": [ - "state", - "closed_at" + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -942515,11 +951024,11 @@ } } }, - "issues-deleted": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -942586,15 +951095,45 @@ "content": { "application/json": { "schema": { - "title": "issues deleted event", + "title": "issues edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "edited" ] }, + "changes": { + "description": "The changes to the issue.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -942779,7 +951318,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -942876,15 +951416,13 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } }, "required": [ @@ -943092,7 +951630,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -943250,6 +951789,8 @@ "watch", "workflow_dispatch", "workflow_run", + "security_and_analysis", + "pull_request_review_thread", "reminder" ] } @@ -943497,7 +952038,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -944561,10 +953103,6 @@ "type": "string", "format": "uri" }, - "title": { - "description": "Title of the issue", - "type": "string" - }, "type": { "title": "Issue Type", "description": "The type of issue.", @@ -944625,6 +953163,10 @@ "description" ] }, + "title": { + "description": "Title of the issue", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time" @@ -944714,7 +953256,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -944755,6 +953298,47 @@ "reactions" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -946186,6 +954770,7 @@ }, "required": [ "action", + "changes", "issue", "repository", "sender" @@ -946211,11 +954796,11 @@ } } }, - "issues-demilestoned": { + "issues-field-added": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue field value was set or updated on an issue.", + "operationId": "issues/field-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -946282,13 +954867,13 @@ "content": { "application/json": { "schema": { - "title": "issues demilestoned event", + "title": "issues field_added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "demilestoned" + "field_added" ] }, "enterprise": { @@ -946384,29 +954969,6 @@ "title": "Issue", "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", "type": "object", - "required": [ - "active_lock_reason", - "assignees", - "author_association", - "body", - "closed_at", - "comments", - "comments_url", - "created_at", - "events_url", - "html_url", - "id", - "labels_url", - "milestone", - "node_id", - "number", - "reactions", - "repository_url", - "title", - "updated_at", - "url", - "user" - ], "properties": { "active_lock_reason": { "type": "string", @@ -946423,10 +954985,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -946509,8 +955067,15 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "assignees": { "type": "array", @@ -946518,10 +955083,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -946604,8 +955165,15 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "login", + "id" + ] } }, "author_association": { @@ -946664,16 +955232,6 @@ "items": { "title": "Label", "type": "object", - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ], - "nullable": true, "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", @@ -946701,7 +955259,16 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] } }, "labels_url": { @@ -946716,24 +955283,6 @@ "description": "A collection of related issues and pull requests.", "type": "object", "nullable": true, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ], "properties": { "closed_at": { "type": "string", @@ -946751,10 +955300,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -946841,7 +955386,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "description": { "type": "string", @@ -946893,7 +955442,25 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, "node_id": { "type": "string" @@ -946906,17 +955473,6 @@ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ], "properties": { "created_at": { "type": "string", @@ -946977,7 +955533,9 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run" + "workflow_run", + "reminder", + "pull_request_review_thread" ] } }, @@ -947006,10 +955564,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -947095,7 +955649,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "permissions": { "description": "The set of permissions for the GitHub app", @@ -947351,7 +955909,18 @@ "nullable": true, "format": "date-time" } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] }, "pull_request": { "type": "object", @@ -947382,18 +955951,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -947426,7 +955983,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "repository_url": { "type": "string", @@ -948355,10 +956924,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -948446,193 +957011,183 @@ "user_view_type": { "type": "string" } - } - } - } - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } }, "required": [ "login", "id" ] - }, - "description": { - "type": "string", - "nullable": true - }, - "due_on": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was set or updated on the issue.", + "properties": { "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue field." }, - "labels_url": { + "name": { "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" + "description": "The name of the issue field." }, - "state": { - "description": "The state of the milestone.", + "field_type": { "type": "string", + "description": "The data type of the issue field.", "enum": [ - "open", - "closed" + "text", + "date", + "single_select", + "number" ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was set or updated for the issue field. When updating an existing value, the previous value is available in `changes`.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] }, - "updated_at": { - "type": "string", - "format": "date-time" + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." }, - "url": { - "type": "string", - "format": "uri" + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } } }, "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" + "id" ] }, + "changes": { + "type": "object", + "description": "The previous field value, present when an existing value was updated.", + "properties": { + "issue_field_value": { + "type": "object", + "description": "The previous issue field value data.", + "properties": { + "from": { + "type": "object", + "description": "The previous value of the issue field before the update.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The previous value. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the previously selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The previously selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "from" + ] + } + } + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -950065,6 +958620,7 @@ "required": [ "action", "issue", + "issue_field", "repository", "sender" ] @@ -950089,11 +958645,11 @@ } } }, - "issues-edited": { + "issues-field-removed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue field value was cleared from an issue.", + "operationId": "issues/field-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -950160,45 +958716,15 @@ "content": { "application/json": { "schema": { - "title": "issues edited event", + "title": "issues field_removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "field_removed" ] }, - "changes": { - "description": "The changes to the issue.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "title": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the title.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -950488,6 +959014,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -950854,9 +959383,8 @@ "watch", "workflow_dispatch", "workflow_run", - "security_and_analysis", - "pull_request_review_thread", - "reminder" + "reminder", + "pull_request_review_thread" ] } }, @@ -952168,6 +960696,10 @@ "type": "string", "format": "uri" }, + "title": { + "description": "Title of the issue", + "type": "string" + }, "type": { "title": "Issue Type", "description": "The type of issue.", @@ -952228,10 +960760,6 @@ "description" ] }, - "title": { - "description": "Title of the issue", - "type": "string" - }, "updated_at": { "type": "string", "format": "date-time" @@ -952363,45 +960891,84 @@ "reactions" ] }, - "label": { - "title": "Label", + "issue_field": { "type": "object", + "description": "The issue field whose value was cleared from the issue.", "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": "string", - "nullable": true - }, "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue field." }, "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" + "type": "string", + "description": "The name of the issue field." }, - "url": { - "description": "URL for the label", + "field_type": { "type": "string", - "format": "uri" + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] } }, "required": [ "id", - "node_id", - "url", "name", - "color", - "default", - "description" + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was cleared from the issue field.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" ] }, "organization": { @@ -953835,8 +962402,8 @@ }, "required": [ "action", - "changes", "issue", + "issue_field", "repository", "sender" ] diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 0922a4cfbc..a861bb3adb 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -73,6 +73,9 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot @@ -857,7 +860,7 @@ paths: - subscriptions_url - type - url - type: &330 + type: &332 type: string description: The type of credit the user is receiving. enum: @@ -990,7 +993,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &129 + schema: &131 title: Validation Error Simple description: Validation Error Simple type: object @@ -1023,7 +1026,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &665 + - &667 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1141,7 +1144,7 @@ paths: GitHub. type: object nullable: true - properties: &81 + properties: &83 id: description: Unique identifier of the GitHub app example: 37 @@ -1274,7 +1277,7 @@ paths: about itself. example: 5 type: integer - required: &82 + required: &84 - id - node_id - owner @@ -1579,7 +1582,7 @@ paths: schema: type: integer default: 30 - - &216 + - &218 name: cursor 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 @@ -1588,7 +1591,7 @@ paths: required: false schema: type: string - - &217 + - &219 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1608,7 +1611,7 @@ paths: application/json: schema: type: array - items: &218 + items: &220 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1688,7 +1691,7 @@ paths: - installation_id - repository_id examples: - default: &219 + default: &221 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1747,7 +1750,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &128 + schema: &130 title: Validation Error description: Validation Error type: object @@ -1816,7 +1819,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &222 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1930,7 +1933,7 @@ paths: - request - response examples: - default: &221 + default: &223 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2131,7 +2134,7 @@ paths: parameters: - *17 - *19 - - &93 + - &95 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2714,7 +2717,7 @@ paths: suspended_at: suspended_by: headers: - Link: &68 + Link: &70 example: ; rel="next", ; rel="last" schema: @@ -2903,11 +2906,11 @@ paths: - selected repositories: type: array - items: &80 + items: &82 title: Repository description: A repository on GitHub. type: object - properties: &295 + properties: &297 id: description: Unique identifier of the repository example: 42 @@ -2927,7 +2930,7 @@ paths: title: License Simple description: License Simple type: object - properties: &89 + properties: &91 key: type: string example: mit @@ -2949,7 +2952,7 @@ paths: html_url: type: string format: uri - required: &90 + required: &92 - key - name - url @@ -3358,7 +3361,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &296 + required: &298 - archive_url - assignees_url - blobs_url @@ -7299,7 +7302,7 @@ paths: required: true content: application/json: - schema: &141 + schema: &143 title: Actions OIDC Custom Property Inclusion Input description: Input for creating an OIDC custom property inclusion type: object @@ -7999,7 +8002,7 @@ paths: description: Response content: application/json: - schema: &188 + schema: &190 type: array description: A list of default code security configurations items: @@ -8015,7 +8018,7 @@ paths: default configuration: *49 examples: - default: &189 + default: &191 value: - default_for_new_repos: public configuration: @@ -8477,7 +8480,7 @@ paths: default: value: default_for_new_repos: all - configuration: &187 + configuration: &189 value: id: 1325 target_type: organization @@ -8567,7 +8570,7 @@ paths: application/json: schema: type: array - items: &190 + items: &192 type: object description: Repositories associated with a code security configuration and attachment status @@ -8589,7 +8592,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &208 + properties: &68 id: type: integer format: int64 @@ -8816,7 +8819,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &209 + required: &69 - archive_url - assignees_url - blobs_url @@ -8868,7 +8871,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &191 + repository: &193 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -9373,7 +9376,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &197 + - &199 name: classification in: query description: |- @@ -9382,7 +9385,7 @@ paths: Can be: `malware`, `general` schema: type: string - - &198 + - &200 name: state in: query description: |- @@ -9391,7 +9394,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &199 + - &201 name: severity in: query description: |- @@ -9400,7 +9403,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &200 + - &202 name: ecosystem in: query description: |- @@ -9409,14 +9412,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &201 + - &203 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &202 + - &204 name: epss_percentage in: query description: |- @@ -9428,7 +9431,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &495 + - &497 name: has in: query description: |- @@ -9442,7 +9445,7 @@ paths: type: string enum: - patch - - &203 + - &205 name: assignee in: query description: |- @@ -9451,7 +9454,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &204 + - &206 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9461,7 +9464,7 @@ paths: enum: - development - runtime - - &205 + - &207 name: sort in: query description: |- @@ -9487,11 +9490,11 @@ paths: application/json: schema: type: array - items: &206 + items: &208 type: object description: A Dependabot alert. properties: - number: &177 + number: &179 type: integer description: The security alert number. readOnly: true @@ -9554,7 +9557,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &496 + security_advisory: &498 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9764,29 +9767,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *66 - url: &180 + url: &182 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &181 + html_url: &183 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &178 + created_at: &180 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &179 + updated_at: &181 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &183 + dismissed_at: &185 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9816,21 +9819,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &182 + fixed_at: &184 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &497 + auto_dismissed_at: &499 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &498 + dismissal_request: &500 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -9892,7 +9895,7 @@ paths: - repository additionalProperties: false examples: - default: &207 + default: &209 value: - number: 2 state: dismissed @@ -10240,6 +10243,266 @@ paths: previews: [] category: dependabot subcategory: alerts + "/enterprises/{enterprise}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an enterprise + description: |- + Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise + parameters: + - *40 + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: &210 + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able + to access in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + title: Simple Repository + description: A GitHub repository. + type: object + properties: *68 + required: *69 + nullable: true + additionalProperties: false + examples: + default: &211 + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an enterprise + description: |- + Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise + parameters: + - *40 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + "/enterprises/{enterprise}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot in an enterprise + description: |- + Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise + parameters: + - *40 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -10261,7 +10524,7 @@ paths: application/json: schema: type: array - items: &69 + items: &71 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -10332,7 +10595,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -10405,9 +10668,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: &77 + default: &79 value: id: 1 name: Justice League @@ -10436,7 +10699,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *40 - - &70 + - &72 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -10455,7 +10718,7 @@ paths: type: array items: *4 examples: - default: &71 + default: &73 value: - login: octocat id: 1 @@ -10476,7 +10739,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10494,7 +10757,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10525,7 +10788,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10543,7 +10806,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10574,7 +10837,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10592,8 +10855,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *40 - - *70 - - &72 + - *72 + - &74 name: username description: The handle for the GitHub user account. in: path @@ -10607,7 +10870,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &73 + exampleKey1: &75 value: login: octocat id: 1 @@ -10643,8 +10906,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *40 - - *70 - *72 + - *74 responses: '201': description: Successfully added team member @@ -10652,7 +10915,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *73 + exampleKey1: *75 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10670,8 +10933,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *40 - - *70 - *72 + - *74 responses: '204': description: Response @@ -10693,7 +10956,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *40 - - *70 + - *72 - *17 - *19 responses: @@ -10703,11 +10966,11 @@ paths: application/json: schema: type: array - items: &74 + items: &76 title: Organization Simple description: A GitHub organization. type: object - properties: &193 + properties: &195 login: type: string example: github @@ -10748,7 +11011,7 @@ paths: type: string example: A great organization nullable: true - required: &194 + required: &196 - login - url - id @@ -10762,7 +11025,7 @@ paths: - avatar_url - description examples: - default: &75 + default: &77 value: login: github id: 1 @@ -10793,7 +11056,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10821,9 +11084,9 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: &117 + default: &119 value: - login: github id: 1 @@ -10854,7 +11117,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10895,8 +11158,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *40 - - *70 - - &76 + - *72 + - &78 name: org description: The organization name. The name is not case sensitive. in: path @@ -10908,9 +11171,9 @@ paths: description: The team is assigned to the organization content: application/json: - schema: *74 + schema: *76 examples: - default: *75 + default: *77 '404': description: The team is not assigned to the organization x-github: @@ -10929,16 +11192,16 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *40 - - *70 - - *76 + - *72 + - *78 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *74 + schema: *76 examples: - default: *75 + default: *77 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10955,8 +11218,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *40 - - *70 - - *76 + - *72 + - *78 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -10980,7 +11243,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *40 - - &78 + - &80 name: team_slug description: The slug of the team name. in: path @@ -10992,11 +11255,11 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: *77 + default: *79 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -11014,7 +11277,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *40 - - *78 + - *80 requestBody: required: true content: @@ -11069,11 +11332,11 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: *77 + default: *79 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -11094,7 +11357,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *40 - - *78 + - *80 responses: '204': description: Response @@ -11132,7 +11395,7 @@ paths: application/json: schema: type: array - items: &112 + items: &114 title: Event description: Event type: object @@ -11142,7 +11405,7 @@ paths: type: type: string nullable: true - actor: &79 + actor: &81 title: Actor description: Actor type: object @@ -11182,7 +11445,7 @@ paths: - id - name - url - org: *79 + org: *81 payload: oneOf: - title: CreateEvent @@ -11228,7 +11491,7 @@ paths: properties: action: type: string - discussion: &758 + discussion: &760 title: Discussion description: A Discussion in a repository. type: object @@ -11515,7 +11778,7 @@ paths: - id labels: type: array - items: &85 + items: &87 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -11590,12 +11853,12 @@ paths: properties: action: type: string - issue: &86 + issue: &88 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &550 + properties: &552 id: type: integer format: int64 @@ -11708,7 +11971,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &279 + properties: &281 url: type: string format: uri @@ -11778,7 +12041,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &280 + required: &282 - closed_issues - creator - description @@ -11857,7 +12120,7 @@ paths: timeline_url: type: string format: uri - type: &242 + type: &244 title: Issue Type description: The type of issue. type: object @@ -11907,7 +12170,7 @@ paths: - node_id - name - description - repository: *80 + repository: *82 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -11918,9 +12181,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - author_association: &83 + properties: *83 + required: *84 + author_association: &85 title: author_association type: string example: OWNER @@ -11935,7 +12198,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &84 + reactions: &86 title: Reaction Rollup type: object properties: @@ -11971,7 +12234,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &676 + sub_issues_summary: &678 title: Sub-issues Summary type: object properties: @@ -11996,7 +12259,7 @@ paths: description: Comments provide a way for people to collaborate on an issue. type: object - properties: &87 + properties: &89 id: description: Unique identifier of the issue comment example: 42 @@ -12039,7 +12302,7 @@ paths: issue_url: type: string format: uri - author_association: *83 + author_association: *85 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend @@ -12050,15 +12313,15 @@ paths: class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - reactions: *84 + properties: *83 + required: *84 + reactions: *86 pin: title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &573 + properties: &575 pinned_at: type: string format: date-time @@ -12070,11 +12333,11 @@ paths: properties: *20 required: *21 nullable: true - required: &574 + required: &576 - pinned_at - pinned_by nullable: true - required: &88 + required: &90 - id - node_id - html_url @@ -12084,7 +12347,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &677 + issue_dependencies_summary: &679 title: Issue Dependencies Summary type: object properties: @@ -12103,7 +12366,7 @@ paths: - total_blocking issue_field_values: type: array - items: &557 + items: &559 title: Issue Field Value description: A value assigned to an issue field type: object @@ -12164,7 +12427,7 @@ paths: - node_id - data_type - value - required: &551 + required: &553 - assignee - closed_at - comments @@ -12189,10 +12452,10 @@ paths: assignees: type: array items: *4 - label: *85 + label: *87 labels: type: array - items: *85 + items: *87 required: - action - issue @@ -12201,14 +12464,14 @@ paths: properties: action: type: string - issue: *86 - comment: &546 + issue: *88 + comment: &548 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 required: - action - issue @@ -12381,8 +12644,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true allow_forking: type: boolean @@ -12471,7 +12734,7 @@ paths: type: string number: type: integer - pull_request: &91 + pull_request: &93 title: Pull Request Minimal type: object properties: @@ -12542,10 +12805,10 @@ paths: assignees: type: array items: *4 - label: *85 + label: *87 labels: type: array - items: *85 + items: *87 required: - action - number @@ -12555,7 +12818,7 @@ paths: properties: action: type: string - pull_request: *91 + pull_request: *93 comment: type: object properties: @@ -12806,7 +13069,7 @@ paths: - pull_request updated_at: type: string - pull_request: *91 + pull_request: *93 required: - action - review @@ -12855,7 +13118,7 @@ paths: updated_at: type: string format: date-time - reactions: *84 + reactions: *86 required: - action - comment @@ -12866,7 +13129,7 @@ paths: type: string release: allOf: - - &607 + - &609 title: Release description: A release. type: object @@ -12937,7 +13200,7 @@ paths: author: *4 assets: type: array - items: &608 + items: &610 title: Release Asset description: Data related to a release. type: object @@ -13012,7 +13275,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *84 + reactions: *86 required: - assets_url - upload_url @@ -13104,7 +13367,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': &120 + '503': &122 description: Service unavailable content: application/json: @@ -13197,7 +13460,7 @@ paths: _links: type: object properties: - timeline: &92 + timeline: &94 title: Link With Type description: Hypermedia Link with Type type: object @@ -13209,17 +13472,17 @@ paths: required: - href - type - user: *92 - security_advisories: *92 - current_user: *92 - current_user_public: *92 - current_user_actor: *92 - current_user_organization: *92 + user: *94 + security_advisories: *94 + current_user: *94 + current_user_public: *94 + current_user_actor: *94 + current_user_organization: *94 current_user_organizations: type: array - items: *92 - repository_discussions: *92 - repository_discussions_category: *92 + items: *94 + repository_discussions: *94 + repository_discussions_category: *94 required: - timeline - user @@ -13281,7 +13544,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *93 + - *95 - *17 - *19 responses: @@ -13291,7 +13554,7 @@ paths: application/json: schema: type: array - items: &94 + items: &96 title: Base Gist description: Base Gist type: object @@ -13390,7 +13653,7 @@ paths: - created_at - updated_at examples: - default: &95 + default: &97 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -13435,7 +13698,7 @@ paths: site_admin: false truncated: false headers: - Link: *68 + Link: *70 '304': *37 '403': *29 x-github: @@ -13511,7 +13774,7 @@ paths: description: Response content: application/json: - schema: &96 + schema: &98 title: Gist Simple description: Gist Simple type: object @@ -13528,7 +13791,7 @@ paths: url: type: string format: uri - user: &683 + user: &685 title: Public User description: Public User type: object @@ -13890,7 +14153,7 @@ paths: truncated: type: boolean examples: - default: &97 + default: &99 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -13994,7 +14257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *93 + - *95 - *17 - *19 responses: @@ -14004,11 +14267,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '403': *29 @@ -14028,7 +14291,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *93 + - *95 - *17 - *19 responses: @@ -14038,11 +14301,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '401': *25 '304': *37 '403': *29 @@ -14067,7 +14330,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &98 + - &100 name: gist_id description: The unique identifier of the gist. in: path @@ -14079,10 +14342,10 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - default: *97 - '403': &101 + default: *99 + '403': &103 description: Forbidden Gist content: application/json: @@ -14129,7 +14392,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *98 + - *100 requestBody: required: true content: @@ -14189,9 +14452,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - updateGist: *97 + updateGist: *99 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -14349,7 +14612,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -14377,7 +14640,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *98 + - *100 - *17 - *19 responses: @@ -14387,7 +14650,7 @@ paths: application/json: schema: type: array - items: &99 + items: &101 title: Gist Comment description: A comment made to a gist. type: object @@ -14422,7 +14685,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *83 + author_association: *85 required: - url - id @@ -14462,7 +14725,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -14486,7 +14749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *98 + - *100 requestBody: required: true content: @@ -14511,9 +14774,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: &100 + default: &102 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -14570,8 +14833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *98 - - &102 + - *100 + - &104 name: comment_id description: The unique identifier of the comment. in: path @@ -14584,12 +14847,12 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: *100 + default: *102 '304': *37 '404': *6 - '403': *101 + '403': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14610,8 +14873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *98 - - *102 + - *100 + - *104 requestBody: required: true content: @@ -14636,9 +14899,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: *100 + default: *102 '404': *6 x-github: githubCloudOnly: false @@ -14655,8 +14918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *98 - - *102 + - *100 + - *104 responses: '204': description: Response @@ -14679,7 +14942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *98 + - *100 - *17 - *19 responses: @@ -14780,7 +15043,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *98 + - *100 - *17 - *19 responses: @@ -14790,7 +15053,7 @@ paths: application/json: schema: type: array - items: *96 + items: *98 examples: default: value: @@ -14836,7 +15099,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 '304': *37 '403': *29 @@ -14855,13 +15118,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *98 + - *100 responses: '201': description: Response content: application/json: - schema: *94 + schema: *96 examples: default: value: @@ -14932,7 +15195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *98 + - *100 responses: '204': description: Response if gist is starred @@ -14962,7 +15225,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -14984,7 +15247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -15012,7 +15275,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *98 + - *100 - name: sha in: path required: true @@ -15023,9 +15286,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - default: *97 + default: *99 '422': *15 '404': *6 '403': *29 @@ -15186,7 +15449,7 @@ paths: type: array items: allOf: - - *80 + - *82 repository_selection: type: string example: selected @@ -15309,7 +15572,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '403': *29 '304': *37 '401': *25 @@ -15393,7 +15656,7 @@ paths: - closed - all default: open - - &245 + - &247 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15412,7 +15675,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - name: collab in: query required: false @@ -15442,9 +15705,9 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: &246 + default: &248 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15689,7 +15952,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '404': *6 @@ -15728,8 +15991,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 examples: default: value: @@ -16014,7 +16277,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &103 + X-CommonMarker-Version: &105 example: 0.17.4 schema: type: string @@ -16069,7 +16332,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *103 + X-CommonMarker-Version: *105 content: text/html: schema: @@ -16098,7 +16361,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &106 + - &108 name: account_id description: account_id parameter in: path @@ -16110,7 +16373,7 @@ paths: description: Response content: application/json: - schema: &105 + schema: &107 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -16140,7 +16403,7 @@ paths: nullable: true id: type: integer - plan: &104 + plan: &106 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -16229,7 +16492,7 @@ paths: nullable: true updated_at: type: string - plan: *104 + plan: *106 required: - url - id @@ -16237,7 +16500,7 @@ paths: - login - marketplace_purchase examples: - default: &107 + default: &109 value: url: https://api.github.com/orgs/github type: Organization @@ -16322,9 +16585,9 @@ paths: application/json: schema: type: array - items: *104 + items: *106 examples: - default: &108 + default: &110 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -16342,7 +16605,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '404': *6 '401': *25 x-github: @@ -16364,14 +16627,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &109 + - &111 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &110 + - &112 name: sort description: The property to sort the results by. in: query @@ -16401,9 +16664,9 @@ paths: application/json: schema: type: array - items: *105 + items: *107 examples: - default: &111 + default: &113 value: - url: https://api.github.com/orgs/github type: Organization @@ -16454,7 +16717,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '404': *6 '422': *15 '401': *25 @@ -16477,15 +16740,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *106 + - *108 responses: '200': description: Response content: application/json: - schema: *105 + schema: *107 examples: - default: *107 + default: *109 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -16517,11 +16780,11 @@ paths: application/json: schema: type: array - items: *104 + items: *106 examples: - default: *108 + default: *110 headers: - Link: *68 + Link: *70 '401': *25 x-github: githubCloudOnly: false @@ -16542,8 +16805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *109 - - *110 + - *111 + - *112 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -16563,11 +16826,11 @@ paths: application/json: schema: type: array - items: *105 + items: *107 examples: - default: *111 + default: *113 headers: - Link: *68 + Link: *70 '401': *25 x-github: githubCloudOnly: false @@ -16829,14 +17092,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &342 + - &344 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &343 + - &345 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16853,7 +17116,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -16898,7 +17161,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &346 + '301': &348 description: Moved permanently content: application/json: @@ -16920,7 +17183,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &583 + - &585 name: all description: If `true`, show notifications marked as read. in: query @@ -16928,7 +17191,7 @@ paths: schema: type: boolean default: false - - &584 + - &586 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16937,8 +17200,8 @@ paths: schema: type: boolean default: false - - *93 - - &585 + - *95 + - &587 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -16963,18 +17226,18 @@ paths: application/json: schema: type: array - items: &113 + items: &115 title: Thread description: Thread type: object properties: id: type: string - repository: &159 + repository: &161 title: Minimal Repository description: Minimal Repository type: object - properties: &211 + properties: &213 id: type: integer format: int64 @@ -17260,7 +17523,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &297 + security_and_analysis: &299 nullable: true type: object properties: @@ -17380,7 +17643,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &212 + required: &214 - archive_url - assignees_url - blobs_url @@ -17468,7 +17731,7 @@ paths: - url - subscription_url examples: - default: &586 + default: &588 value: - id: '1' repository: @@ -17550,7 +17813,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -17634,7 +17897,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &114 + - &116 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -17648,7 +17911,7 @@ paths: description: Response content: application/json: - schema: *113 + schema: *115 examples: default: value: @@ -17750,7 +18013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *114 + - *116 responses: '205': description: Reset Content @@ -17772,7 +18035,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *114 + - *116 responses: '204': description: No content @@ -17795,13 +18058,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *114 + - *116 responses: '200': description: Response content: application/json: - schema: &115 + schema: &117 title: Thread Subscription description: Thread Subscription type: object @@ -17838,7 +18101,7 @@ paths: - url - subscribed examples: - default: &116 + default: &118 value: subscribed: true ignored: false @@ -17869,7 +18132,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *114 + - *116 requestBody: required: false content: @@ -17890,9 +18153,9 @@ paths: description: Response content: application/json: - schema: *115 + schema: *117 examples: - default: *116 + default: *118 '304': *37 '403': *29 '401': *25 @@ -17915,7 +18178,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *114 + - *116 responses: '204': description: Response @@ -18010,9 +18273,9 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: Link: example: ; rel="next" @@ -18039,13 +18302,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &118 + schema: &120 title: Actions cache retention limit for an organization description: GitHub Actions cache retention policy for an organization. type: object @@ -18078,12 +18341,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *118 + schema: *120 examples: selected_actions: *42 responses: @@ -18112,13 +18375,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &119 + schema: &121 title: Actions cache storage limit for an organization description: GitHub Actions cache storage policy for an organization. type: object @@ -18151,12 +18414,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *119 + schema: *121 examples: selected_actions: *44 responses: @@ -18186,7 +18449,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - - *76 + - *78 - name: page description: The page number of the results to fetch. in: query @@ -18358,8 +18621,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization parameters: - - *76 - - &121 + - *78 + - &123 name: budget_id description: The ID corresponding to the budget. in: path @@ -18456,7 +18719,7 @@ paths: '404': *6 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18476,8 +18739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization parameters: - - *76 - - *121 + - *78 + - *123 requestBody: required: true content: @@ -18668,8 +18931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization parameters: - - *76 - - *121 + - *78 + - *123 responses: '200': description: Response when deleting a budget @@ -18696,7 +18959,7 @@ paths: '404': *6 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18716,8 +18979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization parameters: - - *76 - - &122 + - *78 + - &124 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -18726,7 +18989,7 @@ paths: required: false schema: type: integer - - &124 + - &126 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current @@ -18735,7 +18998,7 @@ paths: required: false schema: type: integer - - &123 + - &125 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -18750,14 +19013,14 @@ paths: required: false schema: type: string - - &733 + - &735 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &125 + - &127 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -18874,7 +19137,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18894,9 +19157,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - - *76 - - *122 - - &734 + - *78 + - *124 + - &736 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -18905,7 +19168,7 @@ paths: required: false schema: type: integer - - *123 + - *125 responses: '200': description: Billing usage report response for an organization @@ -18981,7 +19244,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19004,19 +19267,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization parameters: - - *76 - - *122 + - *78 - *124 - - *123 - - &735 + - *126 + - *125 + - &737 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *125 - - &736 + - *127 + - &738 name: sku description: The SKU to query for usage. in: query @@ -19127,7 +19390,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19153,13 +19416,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &126 + schema: &128 title: Organization Full description: Organization Full type: object @@ -19478,7 +19741,7 @@ paths: - updated_at - archived_at examples: - default-response: &127 + default-response: &129 value: login: github id: 1 @@ -19578,7 +19841,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *76 + - *78 requestBody: required: false content: @@ -19794,17 +20057,17 @@ paths: description: Response content: application/json: - schema: *126 + schema: *128 examples: - default: *127 + default: *129 '422': description: Validation failed content: application/json: schema: oneOf: - - *128 - - *129 + - *130 + - *131 '409': *54 x-github: githubCloudOnly: false @@ -19828,7 +20091,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *76 + - *78 responses: '202': *39 '404': *6 @@ -19853,7 +20116,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -19879,7 +20142,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19900,7 +20163,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -19918,7 +20181,7 @@ paths: type: integer repository_cache_usages: type: array - items: &353 + items: &355 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19953,7 +20216,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19973,7 +20236,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -19991,7 +20254,7 @@ paths: type: integer runners: type: array - items: &130 + items: &132 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -20045,7 +20308,7 @@ paths: - display_name - source nullable: true - machine_size_details: &138 + machine_size_details: &140 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -20141,7 +20404,7 @@ paths: - public_ip_enabled - platform examples: - default: &158 + default: &160 value: total_count: 2 runners: @@ -20183,7 +20446,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20201,7 +20464,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -20278,9 +20541,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: &139 + default: &141 value: id: 5 name: My hosted ubuntu runner @@ -20321,7 +20584,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20337,7 +20600,7 @@ paths: type: integer images: type: array - items: &131 + items: &133 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -20388,7 +20651,7 @@ paths: - latest_version - state examples: - default: &133 + default: &135 value: total_count: 2 image_versions: @@ -20419,8 +20682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - - *76 - - &132 + - *78 + - &134 name: image_definition_id description: Image definition ID of custom image in: path @@ -20432,7 +20695,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *133 examples: default: value: @@ -20462,8 +20725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *76 - - *132 + - *78 + - *134 responses: '204': description: Response @@ -20486,8 +20749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - - *132 - - *76 + - *134 + - *78 responses: '200': description: Response @@ -20503,7 +20766,7 @@ paths: type: integer image_versions: type: array - items: &134 + items: &136 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -20536,7 +20799,7 @@ paths: - created_on - state_details examples: - default: *133 + default: *135 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20556,9 +20819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - - *76 - - *132 - - &135 + - *78 + - *134 + - &137 name: version description: Version of a custom image in: path @@ -20571,7 +20834,7 @@ paths: description: Response content: application/json: - schema: *134 + schema: *136 examples: default: value: @@ -20597,9 +20860,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - - *76 - - *132 - - *135 + - *78 + - *134 + - *137 responses: '204': description: Response @@ -20620,7 +20883,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20636,7 +20899,7 @@ paths: type: integer images: type: array - items: &136 + items: &138 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -20672,7 +20935,7 @@ paths: - display_name - source examples: - default: &137 + default: &139 value: id: ubuntu-20.04 platform: linux-x64 @@ -20696,7 +20959,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20712,9 +20975,9 @@ paths: type: integer images: type: array - items: *136 + items: *138 examples: - default: *137 + default: *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20731,7 +20994,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20784,7 +21047,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20800,7 +21063,7 @@ paths: type: integer machine_specs: type: array - items: *138 + items: *140 examples: default: value: @@ -20825,7 +21088,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20869,8 +21132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *76 - - &140 + - *78 + - &142 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -20882,11 +21145,11 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20904,8 +21167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *76 - - *140 + - *78 + - *142 requestBody: required: true content: @@ -20971,9 +21234,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20989,16 +21252,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *76 - - *140 + - *78 + - *142 responses: '202': description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21018,7 +21281,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: A JSON array of OIDC custom property inclusions @@ -21051,12 +21314,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *141 + schema: *143 examples: default: *46 responses: @@ -21090,7 +21353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization parameters: - - *76 + - *78 - name: custom_property_name in: path required: true @@ -21123,7 +21386,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *76 + - *78 responses: '200': description: A JSON serialized template for OIDC subject claim customization @@ -21140,10 +21403,16 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the + name-based format. + type: boolean required: - include_claim_keys examples: - default: &142 + default: &144 value: include_claim_keys: - repo @@ -21165,7 +21434,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -21181,14 +21450,20 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: - default: *142 + default: *144 responses: '201': description: Empty response content: application/json: - schema: &168 + schema: &170 title: Empty Object description: An object without any properties. type: object @@ -21218,7 +21493,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -21227,7 +21502,7 @@ paths: schema: type: object properties: - enabled_repositories: &143 + enabled_repositories: &145 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21240,7 +21515,7 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: &144 + allowed_actions: &146 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -21248,12 +21523,12 @@ paths: - all - local_only - selected - selected_actions_url: &359 + selected_actions_url: &361 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &145 + sha_pinning_required: &147 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -21284,7 +21559,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21295,9 +21570,9 @@ paths: schema: type: object properties: - enabled_repositories: *143 - allowed_actions: *144 - sha_pinning_required: *145 + enabled_repositories: *145 + allowed_actions: *146 + sha_pinning_required: *147 required: - enabled_repositories examples: @@ -21325,13 +21600,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &363 + schema: &365 type: object properties: days: @@ -21368,12 +21643,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &364 + schema: &366 type: object properties: days: @@ -21410,13 +21685,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &146 + schema: &148 type: object properties: approval_policy: @@ -21430,7 +21705,7 @@ paths: required: - approval_policy examples: - default: &365 + default: &367 value: approval_policy: first_time_contributors '404': *6 @@ -21451,7 +21726,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21461,7 +21736,7 @@ paths: required: true content: application/json: - schema: *146 + schema: *148 examples: default: summary: Set approval policy to first time contributors @@ -21483,13 +21758,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &366 + schema: &368 type: object required: - run_workflows_from_fork_pull_requests @@ -21515,7 +21790,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &147 + default: &149 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -21538,12 +21813,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &367 + schema: &369 type: object required: - run_workflows_from_fork_pull_requests @@ -21566,7 +21841,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *147 + default: *149 responses: '204': description: Empty response for successful settings update @@ -21596,7 +21871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -21614,9 +21889,9 @@ paths: type: number repositories: type: array - items: *80 + items: *82 examples: - default: &151 + default: &153 value: total_count: 1 repositories: @@ -21756,7 +22031,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21800,8 +22075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *76 - - &148 + - *78 + - &150 name: repository_id description: The unique identifier of the repository. in: path @@ -21829,8 +22104,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -21853,13 +22128,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &149 + schema: &151 type: object properties: github_owned_allowed: @@ -21881,7 +22156,7 @@ paths: items: type: string examples: - default: &150 + default: &152 value: github_owned_allowed: true verified_allowed: false @@ -21906,7 +22181,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21914,9 +22189,9 @@ paths: required: false content: application/json: - schema: *149 + schema: *151 examples: - selected_actions: *150 + selected_actions: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21936,7 +22211,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -21984,7 +22259,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -22031,7 +22306,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -22046,9 +22321,9 @@ paths: type: integer repositories: type: array - items: *80 + items: *82 examples: - default: *151 + default: *153 '403': *29 '404': *6 x-github: @@ -22068,7 +22343,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -22116,8 +22391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No content @@ -22143,8 +22418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No content @@ -22172,23 +22447,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &368 + schema: &370 type: object properties: - default_workflow_permissions: &152 + default_workflow_permissions: &154 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &153 + can_approve_pull_request_reviews: &155 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -22196,7 +22471,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &154 + default: &156 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -22221,7 +22496,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Success response @@ -22229,13 +22504,13 @@ paths: required: false content: application/json: - schema: &369 + schema: &371 type: object properties: - default_workflow_permissions: *152 - can_approve_pull_request_reviews: *153 + default_workflow_permissions: *154 + can_approve_pull_request_reviews: *155 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22255,7 +22530,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *76 + - *78 - *17 - *19 - name: visible_to_repository @@ -22280,7 +22555,7 @@ paths: type: number runner_groups: type: array - items: &155 + items: &157 type: object properties: id: @@ -22396,7 +22671,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -22468,9 +22743,9 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: - default: &157 + default: &159 value: id: 2 name: octo-runner-group @@ -22505,8 +22780,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *76 - - &156 + - *78 + - &158 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -22518,7 +22793,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: default: value: @@ -22554,8 +22829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -22609,9 +22884,9 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: - default: *157 + default: *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22630,8 +22905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *76 - - *156 + - *78 + - *158 responses: '204': description: Response @@ -22654,8 +22929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *17 - *19 responses: @@ -22673,11 +22948,11 @@ paths: type: number runners: type: array - items: *130 + items: *132 examples: - default: *158 + default: *160 headers: - Link: *68 + Link: *70 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22697,8 +22972,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *19 - *17 responses: @@ -22716,9 +22991,9 @@ paths: type: number repositories: type: array - items: *159 + items: *161 examples: - default: &196 + default: &198 value: total_count: 1 repositories: @@ -22970,8 +23245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -23015,9 +23290,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 - - *148 + - *78 + - *158 + - *150 responses: '204': description: Response @@ -23039,9 +23314,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 - - *148 + - *78 + - *158 + - *150 responses: '204': description: Response @@ -23064,8 +23339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *17 - *19 responses: @@ -23083,7 +23358,7 @@ paths: type: number runners: type: array - items: &161 + items: &163 title: Self hosted runners description: A self hosted runner type: object @@ -23112,7 +23387,7 @@ paths: type: boolean labels: type: array - items: &164 + items: &166 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -23142,7 +23417,7 @@ paths: - busy - labels examples: - default: &162 + default: &164 value: total_count: 2 runners: @@ -23182,7 +23457,7 @@ paths: name: no-gpu type: custom headers: - Link: *68 + Link: *70 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -23201,8 +23476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -23246,9 +23521,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *76 - - *156 - - &160 + - *78 + - *158 + - &162 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -23276,9 +23551,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *76 - - *156 - - *160 + - *78 + - *158 + - *162 responses: '204': description: Response @@ -23308,7 +23583,7 @@ paths: in: query schema: type: string - - *76 + - *78 - *17 - *19 responses: @@ -23326,11 +23601,11 @@ paths: type: integer runners: type: array - items: *161 + items: *163 examples: - default: *162 + default: *164 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23352,7 +23627,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -23360,7 +23635,7 @@ paths: application/json: schema: type: array - items: &370 + items: &372 title: Runner Application description: Runner Application type: object @@ -23385,7 +23660,7 @@ paths: - download_url - filename examples: - default: &371 + default: &373 value: - os: osx architecture: x64 @@ -23428,7 +23703,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -23471,7 +23746,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &372 + '201': &374 description: Response content: application/json: @@ -23481,7 +23756,7 @@ paths: - runner - encoded_jit_config properties: - runner: *161 + runner: *163 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -23538,13 +23813,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *76 + - *78 responses: '201': description: Response content: application/json: - schema: &163 + schema: &165 title: Authentication Token description: Authentication Token type: object @@ -23566,7 +23841,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *80 + items: *82 single_file: type: string example: config.yaml @@ -23582,7 +23857,7 @@ paths: - token - expires_at examples: - default: &373 + default: &375 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23613,15 +23888,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *76 + - *78 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: &374 + default: &376 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23646,16 +23921,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: '200': description: Response content: application/json: - schema: *161 + schema: *163 examples: - default: &375 + default: &377 value: id: 23 name: MBP @@ -23696,8 +23971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: '204': description: Response @@ -23723,10 +23998,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: - '200': &165 + '200': &167 description: Response content: application/json: @@ -23740,7 +24015,7 @@ paths: type: integer labels: type: array - items: *164 + items: *166 examples: default: value: @@ -23779,8 +24054,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 requestBody: required: true content: @@ -23804,7 +24079,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -23828,8 +24103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 requestBody: required: true content: @@ -23854,7 +24129,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -23878,10 +24153,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: - '200': &376 + '200': &378 description: Response content: application/json: @@ -23895,7 +24170,7 @@ paths: type: integer labels: type: array - items: *164 + items: *166 examples: default: value: @@ -23936,9 +24211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 - - &377 + - *78 + - *162 + - &379 name: name description: The name of a self-hosted runner's custom label. in: path @@ -23946,7 +24221,7 @@ paths: schema: type: string responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -23971,7 +24246,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -23989,7 +24264,7 @@ paths: type: integer secrets: type: array - items: &166 + items: &168 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -24039,7 +24314,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24062,13 +24337,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &389 + schema: &391 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24097,7 +24372,7 @@ paths: - key_id - key examples: - default: &390 + default: &392 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24122,8 +24397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *76 - - &167 + - *78 + - &169 name: secret_name description: The name of the secret. in: path @@ -24135,7 +24410,7 @@ paths: description: Response content: application/json: - schema: *166 + schema: *168 examples: default: value: @@ -24165,8 +24440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -24223,7 +24498,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -24249,8 +24524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -24276,8 +24551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -24295,9 +24570,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: &171 + default: &173 value: total_count: 1 repositories: @@ -24389,8 +24664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -24442,8 +24717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -24476,8 +24751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -24509,8 +24784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *76 - - &358 + - *78 + - &360 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -24534,7 +24809,7 @@ paths: type: integer variables: type: array - items: &169 + items: &171 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -24598,7 +24873,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24619,7 +24894,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *76 + - *78 requestBody: required: true content: @@ -24667,7 +24942,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -24692,8 +24967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *76 - - &170 + - *78 + - &172 name: name description: The name of the variable. in: path @@ -24705,7 +24980,7 @@ paths: description: Response content: application/json: - schema: *169 + schema: *171 examples: default: value: @@ -24735,8 +25010,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 requestBody: required: true content: @@ -24798,8 +25073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 responses: '204': description: Response @@ -24825,8 +25100,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - *19 - *17 responses: @@ -24844,9 +25119,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24872,8 +25147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 requestBody: required: true content: @@ -24922,8 +25197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - name: repository_id in: path required: true @@ -24957,8 +25232,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - name: repository_id in: path required: true @@ -24999,7 +25274,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *76 + - *78 requestBody: required: true content: @@ -25122,7 +25397,7 @@ paths: type: integer deployment_records: type: array - items: &172 + items: &174 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -25168,7 +25443,7 @@ paths: required: - total_count examples: - default: &173 + default: &175 value: total_count: 1 deployment_records: @@ -25205,7 +25480,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *76 + - *78 - name: cluster in: path description: The cluster name. @@ -25348,11 +25623,11 @@ paths: type: integer deployment_records: type: array - items: *172 + items: *174 required: - total_count examples: - default: *173 + default: *175 '403': description: Forbidden content: @@ -25399,7 +25674,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *76 + - *78 requestBody: required: true content: @@ -25562,7 +25837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *76 + - *78 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -25587,9 +25862,9 @@ paths: type: integer deployment_records: type: array - items: *172 + items: *174 examples: - default: *173 + default: *175 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25609,7 +25884,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *76 + - *78 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -25694,7 +25969,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 requestBody: required: true content: @@ -25718,12 +25993,12 @@ paths: required: - subject_digests examples: - default: &715 + default: &717 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &716 + withPredicateType: &718 value: subject_digests: - sha256:abc123 @@ -25781,7 +26056,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &717 + default: &719 value: attestations_subject_digests: - sha256:abc: @@ -25890,7 +26165,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *76 + - *78 requestBody: required: true content: @@ -25955,7 +26230,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *76 + - *78 - name: subject_digest description: Subject Digest in: path @@ -25990,7 +26265,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -26038,7 +26313,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *76 + - *78 - name: attestation_id description: Attestation ID in: path @@ -26076,7 +26351,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -26131,7 +26406,7 @@ paths: initiator: type: string examples: - default: &403 + default: &405 value: attestations: - bundle: @@ -26238,7 +26513,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -26250,7 +26525,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26269,8 +26544,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: If the user is blocked @@ -26295,8 +26570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -26316,8 +26591,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -26342,7 +26617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *76 + - *78 - *19 - *17 - *62 @@ -26350,7 +26625,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &174 + schema: &176 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -26376,7 +26651,7 @@ paths: application/json: schema: type: array - items: &175 + items: &177 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -26407,7 +26682,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &195 + items: &197 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -26482,7 +26757,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &257 + properties: &259 id: description: Unique identifier of the team type: integer @@ -26554,7 +26829,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &258 + required: &260 - id - node_id - url @@ -26597,7 +26872,7 @@ paths: type: string format: date-time nullable: true - state: *174 + state: *176 contact_link: description: The contact link of the campaign. type: string @@ -26692,9 +26967,9 @@ paths: closed_at: state: open headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26718,7 +26993,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -26817,9 +27092,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: &176 + default: &178 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -26868,7 +27143,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26890,7 +27165,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -26902,16 +27177,16 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: *176 + default: *178 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26932,7 +27207,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -26981,7 +27256,7 @@ paths: type: string format: uri nullable: true - state: *174 + state: *176 examples: default: value: @@ -26991,9 +27266,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: *176 + default: *178 '400': description: Bad Request content: @@ -27005,7 +27280,7 @@ paths: content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27026,7 +27301,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -27037,7 +27312,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27059,18 +27334,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *76 - - &428 + - *78 + - &430 name: tool_name 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. in: query required: false - schema: &184 + schema: &186 type: string description: The name of the tool used to generate the code scanning analysis. - - &429 + - &431 name: tool_guid 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 @@ -27078,7 +27353,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &185 + schema: &187 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -27093,7 +27368,7 @@ paths: be returned. in: query required: false - schema: &431 + schema: &433 type: string description: State of a code scanning alert. enum: @@ -27116,7 +27391,7 @@ paths: be returned. in: query required: false - schema: &432 + schema: &434 type: string description: Severity of a code scanning alert. enum: @@ -27145,18 +27420,18 @@ paths: items: type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: &433 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: &435 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &186 + state: &188 type: string description: State of a code scanning alert. nullable: true @@ -27164,7 +27439,7 @@ paths: - open - dismissed - fixed - fixed_at: *182 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -27172,8 +27447,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: &434 + dismissed_at: *185 + dismissed_reason: &436 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -27182,13 +27457,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &435 + dismissed_comment: &437 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &436 + rule: &438 type: object properties: id: @@ -27241,42 +27516,42 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &437 + tool: &439 type: object properties: - name: *184 + name: *186 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *185 - most_recent_instance: &438 + guid: *187 + most_recent_instance: &440 type: object properties: - ref: &430 + ref: &432 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &448 + analysis_key: &450 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &449 + environment: &451 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &450 + category: &452 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *186 + state: *188 commit_sha: type: string message: @@ -27290,7 +27565,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &451 + location: &453 type: object description: Describe a region within a file for the alert. properties: @@ -27311,7 +27586,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &452 + items: &454 type: string description: A classification of the file. For example to identify it as generated. @@ -27576,9 +27851,9 @@ paths: trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27600,7 +27875,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *76 + - *78 - name: target_type in: query description: The target type of the code security configuration @@ -27706,7 +27981,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *76 + - *78 requestBody: required: true content: @@ -27950,7 +28225,7 @@ paths: application/json: schema: *49 examples: - default: *187 + default: *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27972,15 +28247,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *188 + schema: *190 examples: - default: *189 + default: *191 '304': *37 '403': *29 '404': *6 @@ -28006,7 +28281,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *76 + - *78 requestBody: required: true content: @@ -28014,6 +28289,8 @@ paths: schema: type: object additionalProperties: false + required: + - selected_repository_ids properties: selected_repository_ids: type: array @@ -28058,7 +28335,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *76 + - *78 - *51 responses: '200': @@ -28067,7 +28344,7 @@ paths: application/json: schema: *49 examples: - default: *187 + default: *189 '304': *37 '403': *29 '404': *6 @@ -28091,7 +28368,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28371,7 +28648,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *76 + - *78 - *51 responses: '204': *61 @@ -28402,7 +28679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28466,7 +28743,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28512,7 +28789,7 @@ paths: default: value: default_for_new_repos: all - configuration: *187 + configuration: *189 '403': *29 '404': *6 x-github: @@ -28536,7 +28813,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *76 + - *78 - *51 - name: per_page description: The number of results per page (max 100). For more information, @@ -28565,13 +28842,13 @@ paths: application/json: schema: type: array - items: *190 + items: *192 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *191 + repository: *193 '403': *29 '404': *6 x-github: @@ -28595,7 +28872,7 @@ paths: parameters: - *17 - *19 - - *76 + - *78 responses: '200': description: Response @@ -28611,7 +28888,7 @@ paths: type: integer codespaces: type: array - items: &247 + items: &249 type: object title: Codespace description: A codespace. @@ -28636,12 +28913,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *159 + repository: *161 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &464 + properties: &466 name: type: string description: The name of the machine. @@ -28683,7 +28960,7 @@ paths: - ready - in_progress nullable: true - required: &465 + required: &467 - name - display_name - operating_system @@ -28888,7 +29165,7 @@ paths: - pulls_url - recent_folders examples: - default: &248 + default: &250 value: total_count: 3 codespaces: @@ -29320,7 +29597,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *76 + - *78 deprecated: true requestBody: required: true @@ -29387,7 +29664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *76 + - *78 deprecated: true requestBody: required: true @@ -29442,7 +29719,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *76 + - *78 requestBody: required: true content: @@ -29494,7 +29771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -29512,7 +29789,7 @@ paths: type: integer secrets: type: array - items: &192 + items: &194 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -29551,7 +29828,7 @@ paths: - updated_at - visibility examples: - default: &466 + default: &468 value: total_count: 2 secrets: @@ -29564,7 +29841,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -29583,13 +29860,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &467 + schema: &469 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -29618,7 +29895,7 @@ paths: - key_id - key examples: - default: &468 + default: &470 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29641,23 +29918,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: Response content: application/json: - schema: *192 + schema: *194 examples: - default: &470 + default: &472 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -29677,8 +29954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -29733,7 +30010,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -29759,8 +30036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -29785,8 +30062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -29804,9 +30081,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 '404': *6 x-github: githubCloudOnly: false @@ -29828,8 +30105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -29879,8 +30156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -29913,8 +30190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -29953,7 +30230,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: OK @@ -30094,7 +30371,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *76 + - *78 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -30117,7 +30394,7 @@ paths: currently being billed. seats: type: array - items: &250 + items: &252 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -30134,15 +30411,15 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *193 - required: *194 + properties: *195 + required: *196 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *195 - - *69 + - *197 + - *71 nullable: true pending_cancellation_date: type: string @@ -30266,7 +30543,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '500': *55 '401': *25 '403': *29 @@ -30300,7 +30577,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30378,7 +30655,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30458,7 +30735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30535,7 +30812,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30613,7 +30890,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -30678,7 +30955,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -30733,7 +31010,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -30748,12 +31025,12 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 required: - total_count - repositories examples: - default: *196 + default: *198 '500': *55 '401': *25 '403': *29 @@ -30782,7 +31059,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -30838,8 +31115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No Content @@ -30872,8 +31149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No Content @@ -30912,7 +31189,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization parameters: - - *76 + - *78 responses: '200': description: OK @@ -30965,7 +31242,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization parameters: - - *76 + - *78 requestBody: description: The content exclusion rules to set required: true @@ -31056,7 +31333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *76 + - *78 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -31088,7 +31365,7 @@ paths: application/json: schema: type: array - items: &335 + items: &337 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -31395,7 +31672,7 @@ paths: - date additionalProperties: true examples: - default: &336 + default: &338 value: - date: '2024-06-24' total_active_users: 24 @@ -31497,7 +31774,7 @@ paths: '500': *55 '403': *29 '404': *6 - '422': &337 + '422': &339 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -31528,7 +31805,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day parameters: - - *76 + - *78 - *56 responses: '200': @@ -31567,7 +31844,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics parameters: - - *76 + - *78 responses: '200': description: Response @@ -31604,7 +31881,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day parameters: - - *76 + - *78 - *56 responses: '200': @@ -31643,7 +31920,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics parameters: - - *76 + - *78 responses: '200': description: Response @@ -31676,13 +31953,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *76 - - *197 - - *198 + - *78 - *199 - *200 - *201 - *202 + - *203 + - *204 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -31712,7 +31989,7 @@ paths: enum: - patch - deployment - - *203 + - *205 - name: runtime_risk in: query description: |- @@ -31721,8 +31998,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *204 - - *205 + - *206 + - *207 - *62 - *47 - *48 @@ -31734,9 +32011,9 @@ paths: application/json: schema: type: array - items: *206 + items: *208 examples: - default: *207 + default: *209 '304': *37 '400': *14 '403': *29 @@ -31762,7 +32039,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *76 + - *78 - name: page in: query description: The page number of results to fetch. @@ -31785,104 +32062,9 @@ paths: description: Response content: application/json: - schema: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able - to access in an organization - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot - updates. - enum: - - public - - internal - example: internal - nullable: true - accessible_repositories: - type: array - items: - title: Simple Repository - description: A GitHub repository. - type: object - properties: *208 - required: *209 - nullable: true - additionalProperties: false + schema: *210 examples: - default: - value: - default_level: public - accessible_repositories: - - id: 123456 - node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= - name: example-repo - full_name: octocat/example-repo - owner: - name: octocat - email: octo@github.com - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://avatars.githubusercontent.com/u/1?v=4 - gravatar_id: 1 - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat/example-repo - 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 - starred_at: '"2020-07-09T00:17:55Z"' - user_view_type: default - private: false - html_url: https://github.com/octocat/example-repo - description: This is an example repository. - fork: false - url: https://api.github.com/repos/octocat/example-repo - archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} - commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} - compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/example-repo/contributors - deployments_url: https://api.github.com/repos/octocat/example-repo/deployments - downloads_url: https://api.github.com/repos/octocat/example-repo/downloads - events_url: https://api.github.com/repos/octocat/example-repo/events - forks_url: https://api.github.com/repos/octocat/example-repo/forks - git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} - keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} - languages_url: https://api.github.com/repos/octocat/example-repo/languages - merges_url: https://api.github.com/repos/octocat/example-repo/merges - milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} - releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers - statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/example-repo/subscription - tags_url: https://api.github.com/repos/octocat/example-repo/tags - teams_url: https://api.github.com/repos/octocat/example-repo/teams - trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + default: *211 '403': *29 '404': *6 x-github: @@ -31913,7 +32095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -31979,7 +32161,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *76 + - *78 requestBody: required: true content: @@ -32027,7 +32209,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32045,7 +32227,7 @@ paths: type: integer secrets: type: array - items: &210 + items: &212 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -32095,7 +32277,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32116,13 +32298,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &501 + schema: &503 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -32139,7 +32321,7 @@ paths: - key_id - key examples: - default: &502 + default: &504 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -32162,14 +32344,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: Response content: application/json: - schema: *210 + schema: *212 examples: default: value: @@ -32197,8 +32379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -32255,7 +32437,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -32279,8 +32461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -32304,8 +32486,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -32323,9 +32505,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32346,8 +32528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -32397,8 +32579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -32429,8 +32611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -32460,7 +32642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -32468,7 +32650,7 @@ paths: application/json: schema: type: array - items: &260 + items: &262 title: Package description: A software package type: object @@ -32518,8 +32700,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *211 - required: *212 + properties: *213 + required: *214 nullable: true created_at: type: string @@ -32538,7 +32720,7 @@ paths: - created_at - updated_at examples: - default: &261 + default: &263 value: - id: 197 name: hello_docker @@ -32616,7 +32798,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32626,7 +32808,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: 200-response: value: @@ -32698,7 +32880,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32708,7 +32890,7 @@ paths: application/json: schema: type: array - items: &236 + items: &238 title: Organization Invitation description: Organization Invitation type: object @@ -32755,7 +32937,7 @@ paths: - invitation_teams_url - node_id examples: - default: &237 + default: &239 value: - id: 1 login: monalisa @@ -32788,7 +32970,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -32812,7 +32994,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32822,7 +33004,7 @@ paths: application/json: schema: type: array - items: &213 + items: &215 title: Org Hook description: Org Hook type: object @@ -32910,7 +33092,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -32933,7 +33115,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *76 + - *78 requestBody: required: true content: @@ -32993,9 +33175,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *215 examples: - default: &214 + default: &216 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -33042,8 +33224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *76 - - &215 + - *78 + - &217 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -33056,9 +33238,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *215 examples: - default: *214 + default: *216 '404': *6 x-github: githubCloudOnly: false @@ -33085,8 +33267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 requestBody: required: false content: @@ -33131,7 +33313,7 @@ paths: description: Response content: application/json: - schema: *213 + schema: *215 examples: default: value: @@ -33172,8 +33354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 responses: '204': description: Response @@ -33200,8 +33382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *76 - - *215 + - *78 + - *217 responses: '200': description: Response @@ -33231,8 +33413,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *76 - - *215 + - *78 + - *217 requestBody: required: false content: @@ -33282,11 +33464,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *76 - - *215 - - *17 - - *216 + - *78 - *217 + - *17 + - *218 + - *219 responses: '200': description: Response @@ -33294,9 +33476,9 @@ paths: application/json: schema: type: array - items: *218 + items: *220 examples: - default: *219 + default: *221 '400': *14 '422': *15 x-github: @@ -33321,17 +33503,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 - *16 responses: '200': description: Response content: application/json: - schema: *220 + schema: *222 examples: - default: *221 + default: *223 '400': *14 '422': *15 x-github: @@ -33356,8 +33538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 - *16 responses: '202': *39 @@ -33386,8 +33568,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 responses: '204': description: Response @@ -33409,8 +33591,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *76 - - &226 + - *78 + - &228 name: actor_type in: path description: The type of the actor @@ -33423,14 +33605,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &227 + - &229 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &222 + - &224 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -33438,7 +33620,7 @@ paths: required: true schema: type: string - - &223 + - &225 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -33531,13 +33713,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *76 - - *222 - - *223 + - *78 + - *224 + - *225 - *19 - *17 - *62 - - &232 + - &234 name: sort description: The property to sort the results by. in: query @@ -33614,15 +33796,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *76 - - *222 - - *223 + - *78 + - *224 + - *225 responses: '200': description: Response content: application/json: - schema: &224 + schema: &226 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -33638,7 +33820,7 @@ paths: type: integer format: int64 examples: - default: &225 + default: &227 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -33658,24 +33840,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *76 - - &228 + - *78 + - &230 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *222 - - *223 + - *224 + - *225 responses: '200': description: Response content: application/json: - schema: *224 + schema: *226 examples: - default: *225 + default: *227 x-github: enabledForGitHubApps: true category: orgs @@ -33693,19 +33875,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *76 - - *222 - - *223 - - *226 - - *227 + - *78 + - *224 + - *225 + - *228 + - *229 responses: '200': description: Response content: application/json: - schema: *224 + schema: *226 examples: - default: *225 + default: *227 x-github: enabledForGitHubApps: true category: orgs @@ -33722,10 +33904,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *76 - - *222 - - *223 - - &229 + - *78 + - *224 + - *225 + - &231 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -33738,7 +33920,7 @@ paths: description: Response content: application/json: - schema: &230 + schema: &232 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -33754,7 +33936,7 @@ paths: type: integer format: int64 examples: - default: &231 + default: &233 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -33790,19 +33972,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *76 - - *228 - - *222 - - *223 - - *229 + - *78 + - *230 + - *224 + - *225 + - *231 responses: '200': description: Response content: application/json: - schema: *230 + schema: *232 examples: - default: *231 + default: *233 x-github: enabledForGitHubApps: true category: orgs @@ -33819,20 +34001,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *76 - - *226 - - *227 - - *222 - - *223 + - *78 + - *228 - *229 + - *224 + - *225 + - *231 responses: '200': description: Response content: application/json: - schema: *230 + schema: *232 examples: - default: *231 + default: *233 x-github: enabledForGitHubApps: true category: orgs @@ -33849,14 +34031,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *76 - - *228 - - *222 - - *223 + - *78 + - *230 + - *224 + - *225 - *19 - *17 - *62 - - *232 + - *234 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -33929,7 +34111,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *76 + - *78 responses: '200': description: Response @@ -33937,7 +34119,7 @@ paths: application/json: schema: *22 examples: - default: &541 + default: &543 value: id: 1 account: @@ -34006,7 +34188,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -34076,7 +34258,7 @@ paths: suspended_at: suspended_by: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34095,7 +34277,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -34103,12 +34285,12 @@ paths: application/json: schema: anyOf: - - &234 + - &236 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &233 + limit: &235 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -34133,7 +34315,7 @@ paths: properties: {} additionalProperties: false examples: - default: &235 + default: &237 value: limit: collaborators_only origin: organization @@ -34157,18 +34339,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &542 + schema: &544 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *233 + limit: *235 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -34192,9 +34374,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *236 examples: - default: *235 + default: *237 '422': *15 x-github: githubCloudOnly: false @@ -34212,7 +34394,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -34236,7 +34418,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *76 + - *78 - *17 - *19 - name: role @@ -34270,11 +34452,11 @@ paths: application/json: schema: type: array - items: *236 + items: *238 examples: - default: *237 + default: *239 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -34295,7 +34477,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *76 + - *78 requestBody: required: false content: @@ -34349,7 +34531,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *238 examples: default: value: @@ -34403,8 +34585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *76 - - &238 + - *78 + - &240 name: invitation_id description: The unique identifier of the invitation. in: path @@ -34434,8 +34616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *76 - - *238 + - *78 + - *240 - *17 - *19 responses: @@ -34445,9 +34627,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: &259 + default: &261 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -34463,7 +34645,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -34482,7 +34664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#list-issue-fields-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -34490,7 +34672,7 @@ paths: application/json: schema: type: array - items: &239 + items: &241 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -34633,7 +34815,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#create-issue-field-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -34723,9 +34905,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *241 examples: - default: &240 + default: &242 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -34780,8 +34962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - - *76 - - &241 + - *78 + - &243 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -34889,9 +35071,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *241 examples: - default: *240 + default: *242 '404': *6 '422': *7 x-github: @@ -34915,8 +35097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - - *76 - - *241 + - *78 + - *243 responses: '204': *61 '404': *6 @@ -34938,7 +35120,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -34946,7 +35128,7 @@ paths: application/json: schema: type: array - items: *242 + items: *244 examples: default: value: @@ -34984,7 +35166,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -35031,9 +35213,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *244 examples: - default: &243 + default: &245 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -35065,8 +35247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *76 - - &244 + - *78 + - &246 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -35119,9 +35301,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *244 examples: - default: *243 + default: *245 '404': *6 '422': *7 x-github: @@ -35145,8 +35327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *76 - - *244 + - *78 + - *246 responses: '204': description: Response @@ -35179,7 +35361,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *76 + - *78 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -35209,7 +35391,7 @@ paths: - closed - all default: open - - *245 + - *247 - name: type description: Can be the name of an issue type. in: query @@ -35228,7 +35410,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -35238,11 +35420,11 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *246 + default: *248 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -35262,7 +35444,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *76 + - *78 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -35300,9 +35482,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -35320,8 +35502,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response if requester is an organization member and user is @@ -35355,8 +35537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -35382,8 +35564,8 @@ paths: parameters: - *17 - *19 - - *76 - - *72 + - *78 + - *74 responses: '200': description: Response @@ -35399,9 +35581,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *249 examples: - default: *248 + default: *250 '304': *37 '500': *55 '401': *25 @@ -35426,9 +35608,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *76 - - *72 - - &249 + - *78 + - *74 + - &251 name: codespace_name in: path required: true @@ -35461,17 +35643,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *76 - - *72 - - *249 + - *78 + - *74 + - *251 responses: '200': description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: &463 + default: &465 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -35644,14 +35826,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *250 + schema: *252 examples: default: value: @@ -35720,14 +35902,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '200': description: Response content: application/json: - schema: &251 + schema: &253 title: Org Membership description: Org Membership type: object @@ -35771,7 +35953,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *74 + organization: *76 user: title: Simple User description: A GitHub user. @@ -35794,7 +35976,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &252 + response-if-user-has-an-active-admin-membership-with-organization: &254 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -35866,8 +36048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 requestBody: required: false content: @@ -35895,9 +36077,9 @@ paths: description: Response content: application/json: - schema: *251 + schema: *253 examples: - response-if-user-already-had-membership-with-organization: *252 + response-if-user-already-had-membership-with-organization: *254 '422': *15 '403': *29 x-github: @@ -35921,8 +36103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -35947,7 +36129,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *76 + - *78 - *17 - *19 - name: exclude @@ -35968,7 +36150,7 @@ paths: application/json: schema: type: array - items: &253 + items: &255 title: Migration description: A migration. type: object @@ -36009,7 +36191,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *80 + items: *82 url: type: string format: uri @@ -36205,7 +36387,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36221,7 +36403,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *76 + - *78 requestBody: required: true content: @@ -36297,7 +36479,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *255 examples: default: value: @@ -36475,8 +36657,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *76 - - &254 + - *78 + - &256 name: migration_id description: The unique identifier of the migration. in: path @@ -36503,7 +36685,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *253 + schema: *255 examples: default: value: @@ -36672,8 +36854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *76 - - *254 + - *78 + - *256 responses: '302': description: Response @@ -36694,8 +36876,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *76 - - *254 + - *78 + - *256 responses: '204': description: Response @@ -36718,9 +36900,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *76 - - *254 - - &698 + - *78 + - *256 + - &700 name: repo_name description: repo_name parameter in: path @@ -36747,8 +36929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *76 - - *254 + - *78 + - *256 - *17 - *19 responses: @@ -36758,9 +36940,9 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: &266 + default: &268 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -36873,7 +37055,7 @@ paths: secret_scanning_delegated_alert_dismissal: status: disabled headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -36899,7 +37081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response - list of organization roles @@ -36915,7 +37097,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &256 + items: &258 title: Organization Role description: Organization roles type: object @@ -37062,8 +37244,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -37088,9 +37270,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *76 - *78 - - &255 + - *80 + - &257 name: role_id description: The unique identifier of the role. in: path @@ -37125,9 +37307,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *76 - *78 - - *255 + - *80 + - *257 responses: '204': description: Response @@ -37152,8 +37334,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -37178,9 +37360,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *76 - - *72 - - *255 + - *78 + - *74 + - *257 responses: '204': description: Response @@ -37210,9 +37392,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *76 - - *72 - - *255 + - *78 + - *74 + - *257 responses: '204': description: Response @@ -37240,14 +37422,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *76 - - *255 + - *78 + - *257 responses: '200': description: Response content: application/json: - schema: *256 + schema: *258 examples: default: value: @@ -37297,8 +37479,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *76 - - *255 + - *78 + - *257 - *17 - *19 responses: @@ -37376,8 +37558,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *259 + required: *260 nullable: true type: description: The ownership type of the team @@ -37409,9 +37591,9 @@ paths: - type - parent examples: - default: *259 + default: *261 headers: - Link: *68 + Link: *70 '404': description: Response if the organization or role does not exist. '422': @@ -37438,8 +37620,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *76 - - *255 + - *78 + - *257 - *17 - *19 responses: @@ -37467,13 +37649,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &331 + items: &333 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *259 + required: *260 name: nullable: true type: string @@ -37568,9 +37750,9 @@ paths: - type - url examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': description: Response if the organization or role does not exist. '422': @@ -37592,7 +37774,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *76 + - *78 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -37619,9 +37801,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37644,8 +37826,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *76 - - *72 + - *78 + - *74 requestBody: required: false content: @@ -37702,8 +37884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -37760,8 +37942,8 @@ paths: - docker - nuget - container - - *76 - - &699 + - *78 + - &701 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -37797,12 +37979,12 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: *261 + default: *263 '403': *29 '401': *25 - '400': &701 + '400': &703 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -37824,7 +38006,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &262 + - &264 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -37842,20 +38024,20 @@ paths: - docker - nuget - container - - &263 + - &265 name: package_name description: The name of the package. in: path required: true schema: type: string - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *260 + schema: *262 examples: default: value: @@ -37907,9 +38089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *262 - - *263 - - *76 + - *264 + - *265 + - *78 responses: '204': description: Response @@ -37941,9 +38123,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *262 - - *263 - - *76 + - *264 + - *265 + - *78 - name: token description: package token schema: @@ -37975,9 +38157,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *262 - - *263 - - *76 + - *264 + - *265 + - *78 - *19 - *17 - name: state @@ -37997,7 +38179,7 @@ paths: application/json: schema: type: array - items: &264 + items: &266 title: Package Version description: A version of a software package type: object @@ -38122,10 +38304,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *262 - - *263 - - *76 - - &265 + - *264 + - *265 + - *78 + - &267 name: package_version_id description: Unique identifier of the package version. in: path @@ -38137,7 +38319,7 @@ paths: description: Response content: application/json: - schema: *264 + schema: *266 examples: default: value: @@ -38173,10 +38355,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *262 - - *263 - - *76 + - *264 - *265 + - *78 + - *267 responses: '204': description: Response @@ -38208,10 +38390,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *262 - - *263 - - *76 + - *264 - *265 + - *78 + - *267 responses: '204': description: Response @@ -38238,10 +38420,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *76 + - *78 - *17 - *19 - - &267 + - &269 name: sort description: The property by which to sort the results. in: query @@ -38252,7 +38434,7 @@ paths: - created_at default: created_at - *62 - - &268 + - &270 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -38263,7 +38445,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &269 + - &271 name: repository description: The name of the repository to use to filter the results. in: query @@ -38271,7 +38453,7 @@ paths: schema: type: string example: Hello-World - - &270 + - &272 name: permission description: The permission to use to filter the results. in: query @@ -38279,7 +38461,7 @@ paths: schema: type: string example: issues_read - - &271 + - &273 name: last_used_before 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) @@ -38289,7 +38471,7 @@ paths: schema: type: string format: date-time - - &272 + - &274 name: last_used_after 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) @@ -38299,7 +38481,7 @@ paths: schema: type: string format: date-time - - &273 + - &275 name: token_id description: The ID of the token in: query @@ -38443,7 +38625,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38463,7 +38645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *76 + - *78 requestBody: required: true content: @@ -38529,7 +38711,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *76 + - *78 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -38590,7 +38772,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *76 + - *78 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -38610,11 +38792,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38635,17 +38817,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *76 + - *78 - *17 - *19 - - *267 - - *62 - - *268 - *269 + - *62 - *270 - *271 - *272 - *273 + - *274 + - *275 responses: '500': *55 '422': *15 @@ -38774,7 +38956,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38794,7 +38976,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *76 + - *78 requestBody: required: true content: @@ -38854,7 +39036,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *76 + - *78 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -38906,7 +39088,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *76 + - *78 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -38925,11 +39107,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38951,7 +39133,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -38969,7 +39151,7 @@ paths: type: integer configurations: type: array - items: &274 + items: &276 title: Organization private registry description: Private registry configuration for an organization type: object @@ -39098,7 +39280,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *68 + Link: *70 '400': *14 '404': *6 x-github: @@ -39121,7 +39303,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -39440,7 +39622,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &275 + org-private-registry-with-selected-visibility: &277 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -39481,7 +39663,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -39507,7 +39689,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -39529,16 +39711,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *274 + schema: *276 examples: - default: *275 + default: *277 '404': *6 x-github: githubCloudOnly: false @@ -39560,8 +39742,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -39737,8 +39919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -39761,7 +39943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *76 + - *78 - name: q description: Limit results to projects of the specified type. in: query @@ -39778,7 +39960,7 @@ paths: application/json: schema: type: array - items: &276 + items: &278 title: Projects v2 Project description: A projects v2 project type: object @@ -39848,7 +40030,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &789 + properties: &791 id: type: number description: The unique identifier of the status update. @@ -39896,7 +40078,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &790 + required: &792 - id - node_id - created_at @@ -39921,7 +40103,7 @@ paths: - deleted_at - deleted_by examples: - default: &277 + default: &279 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -40004,7 +40186,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -40024,24 +40206,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &278 + - &280 name: project_number description: The project's number. in: path required: true schema: type: integer - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *276 + schema: *278 examples: - default: *277 + default: *279 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -40061,8 +40243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *76 - - *278 + - *78 + - *280 requestBody: required: true description: Details of the draft item to create in the project. @@ -40096,7 +40278,7 @@ paths: description: Response content: application/json: - schema: &284 + schema: &286 title: Projects v2 Item description: An item belonging to a project type: object @@ -40109,8 +40291,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *86 - - &480 + - *88 + - &482 title: Pull Request Simple description: Pull Request Simple type: object @@ -40216,8 +40398,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *281 + required: *282 nullable: true active_lock_reason: type: string @@ -40260,7 +40442,7 @@ paths: items: *4 requested_teams: type: array - items: *195 + items: *197 head: type: object properties: @@ -40268,7 +40450,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: @@ -40291,7 +40473,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: @@ -40310,7 +40492,7 @@ paths: _links: type: object properties: - comments: &281 + comments: &283 title: Link description: Hypermedia Link type: object @@ -40319,13 +40501,13 @@ paths: type: string required: - href - commits: *281 - statuses: *281 - html: *281 - issue: *281 - review_comments: *281 - review_comment: *281 - self: *281 + commits: *283 + statuses: *283 + html: *283 + issue: *283 + review_comments: *283 + review_comment: *283 + self: *283 required: - comments - commits @@ -40335,8 +40517,8 @@ paths: - review_comments - review_comment - self - author_association: *83 - auto_merge: &593 + author_association: *85 + auto_merge: &595 title: Auto merge description: The status of auto merging a pull request. type: object @@ -40438,7 +40620,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &283 + content_type: &285 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -40478,7 +40660,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &285 + draft_issue: &287 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -40552,8 +40734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *278 - - *76 + - *280 + - *78 - *17 - *47 - *48 @@ -40564,7 +40746,7 @@ paths: application/json: schema: type: array - items: &282 + items: &284 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -40714,7 +40896,7 @@ paths: - updated_at - project_url examples: - default: &720 + default: &722 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40825,7 +41007,7 @@ paths: created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -40844,8 +41026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *278 - - *76 + - *280 + - *78 requestBody: required: true content: @@ -40891,7 +41073,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &721 + items: &723 type: object properties: name: @@ -40928,7 +41110,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &722 + iteration_configuration: &724 type: object description: The configuration for iteration fields. properties: @@ -40978,7 +41160,7 @@ paths: value: name: Due date data_type: date - single_select_field: &723 + single_select_field: &725 summary: Create a single select field value: name: Priority @@ -41005,7 +41187,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &724 + iteration_field: &726 summary: Create an iteration field value: name: Sprint @@ -41029,9 +41211,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *282 + schema: *284 examples: - text_field: &725 + text_field: &727 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -41040,7 +41222,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &726 + number_field: &728 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -41049,7 +41231,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &727 + date_field: &729 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -41058,7 +41240,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &728 + single_select_field: &730 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41092,7 +41274,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &729 + iteration_field: &731 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -41137,23 +41319,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *278 - - &730 + - *280 + - &732 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *282 + schema: *284 examples: - default: &731 + default: &733 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41188,7 +41370,7 @@ paths: created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -41209,8 +41391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *278 - - *76 + - *280 + - *78 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -41242,7 +41424,7 @@ paths: application/json: schema: type: array - items: &286 + items: &288 title: Projects v2 Item description: An item belonging to a project type: object @@ -41258,7 +41440,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *283 + content_type: *285 content: type: object additionalProperties: true @@ -41301,7 +41483,7 @@ paths: - updated_at - archived_at examples: - default: &287 + default: &289 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -41978,7 +42160,7 @@ paths: data_type: sub_issues_progress value: headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -41998,8 +42180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *76 - - *278 + - *78 + - *280 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -42069,22 +42251,22 @@ paths: description: Response content: application/json: - schema: *284 + schema: *286 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *285 + value: *287 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *285 + value: *287 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *285 + value: *287 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *285 + value: *287 '304': *37 '403': *29 '401': *25 @@ -42104,9 +42286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *278 - - *76 - - &288 + - *280 + - *78 + - &290 name: item_id description: The unique identifier of the project item. in: path @@ -42132,11 +42314,11 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -42155,9 +42337,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *278 - - *76 - - *288 + - *280 + - *78 + - *290 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -42227,13 +42409,13 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - text_field: *287 - number_field: *287 - date_field: *287 - single_select_field: *287 - iteration_field: *287 + text_field: *289 + number_field: *289 + date_field: *289 + single_select_field: *289 + iteration_field: *289 '401': *25 '403': *29 '404': *6 @@ -42253,9 +42435,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *278 - - *76 - - *288 + - *280 + - *78 + - *290 responses: '204': description: Response @@ -42278,8 +42460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - - *76 - - *278 + - *78 + - *280 requestBody: required: true content: @@ -42350,7 +42532,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &712 + schema: &714 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -42448,7 +42630,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &289 + value: &291 value: id: 1 number: 1 @@ -42494,10 +42676,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *289 + value: *291 roadmap_view: summary: Response for creating a roadmap view - value: *289 + value: *291 '304': *37 '403': *29 '401': *25 @@ -42525,9 +42707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *278 - - *76 - - &732 + - *280 + - *78 + - &734 name: view_number description: The number that identifies the project view. in: path @@ -42559,11 +42741,11 @@ paths: application/json: schema: type: array - items: *286 + items: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -42586,7 +42768,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -42594,7 +42776,7 @@ paths: application/json: schema: type: array - items: &290 + items: &292 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -42662,7 +42844,7 @@ paths: - property_name - value_type examples: - default: &291 + default: &293 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42711,7 +42893,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -42722,7 +42904,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *290 + items: *292 minItems: 1 maxItems: 100 required: @@ -42752,9 +42934,9 @@ paths: application/json: schema: type: array - items: *290 + items: *292 examples: - default: *291 + default: *293 '403': *29 '404': *6 x-github: @@ -42775,8 +42957,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *76 - - &292 + - *78 + - &294 name: custom_property_name description: The custom property name in: path @@ -42788,9 +42970,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *292 examples: - default: &293 + default: &295 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42824,8 +43006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *76 - - *292 + - *78 + - *294 requestBody: required: true content: @@ -42896,9 +43078,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *292 examples: - default: *293 + default: *295 '403': *29 '404': *6 x-github: @@ -42921,8 +43103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *76 - - *292 + - *78 + - *294 responses: '204': *61 '403': *29 @@ -42945,7 +43127,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *76 + - *78 - *17 - *19 - name: repository_query @@ -42983,7 +43165,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &294 + items: &296 title: Custom Property Value description: Custom property name and associated value type: object @@ -43022,7 +43204,7 @@ paths: - property_name: team value: octocat headers: - Link: *68 + Link: *70 '403': *29 '404': *6 x-github: @@ -43050,7 +43232,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *76 + - *78 requestBody: required: true content: @@ -43070,7 +43252,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *294 + items: *296 required: - repository_names - properties @@ -43111,7 +43293,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *76 + - *78 - *17 - *19 responses: @@ -43123,9 +43305,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43142,8 +43324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response if user is a public member @@ -43167,8 +43349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -43189,8 +43371,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -43214,7 +43396,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *76 + - *78 - name: type description: Specifies the types of repositories you want returned. in: query @@ -43260,11 +43442,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43283,7 +43465,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *76 + - *78 requestBody: required: true content: @@ -43464,7 +43646,7 @@ paths: description: Response content: application/json: - schema: &345 + schema: &347 title: Full Repository description: Full Repository type: object @@ -43752,8 +43934,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *295 - required: *296 + properties: *297 + required: *298 nullable: true temp_clone_token: type: string @@ -43840,8 +44022,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true organization: title: Simple User @@ -43850,8 +44032,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *80 - source: *80 + parent: *82 + source: *82 forks: type: integer master_branch: @@ -43868,7 +44050,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &485 + properties: &487 url: type: string format: uri @@ -43884,12 +44066,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &486 + required: &488 - url - key - name - html_url - security_and_analysis: *297 + security_and_analysis: *299 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -43973,7 +44155,7 @@ paths: - network_count - subscribers_count examples: - default: &347 + default: &349 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -44491,10 +44673,10 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - *17 - *19 - - &615 + - &617 name: targets description: | A comma-separated list of rule targets to filter by. @@ -44512,7 +44694,7 @@ paths: application/json: schema: type: array - items: &324 + items: &326 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -44547,7 +44729,7 @@ paths: source: type: string description: The name of the source - enforcement: &300 + enforcement: &302 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -44560,7 +44742,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &301 + items: &303 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -44630,7 +44812,7 @@ paths: conditions: nullable: true anyOf: - - &298 + - &300 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -44654,7 +44836,7 @@ paths: match. items: type: string - - &302 + - &304 title: Organization ruleset conditions type: object description: |- @@ -44668,7 +44850,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *298 + - *300 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -44702,7 +44884,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *298 + - *300 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -44724,7 +44906,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *298 + - *300 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -44737,7 +44919,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &299 + items: &301 title: Repository ruleset property targeting definition type: object @@ -44770,17 +44952,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *299 + items: *301 required: - repository_property rules: type: array - items: &616 + items: &618 title: Repository Rule type: object description: A repository rule. oneOf: - - &303 + - &305 title: creation description: Only allow users with bypass permission to create matching refs. @@ -44792,7 +44974,7 @@ paths: type: string enum: - creation - - &304 + - &306 title: update description: Only allow users with bypass permission to update matching refs. @@ -44813,7 +44995,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &305 + - &307 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -44825,7 +45007,7 @@ paths: type: string enum: - deletion - - &306 + - &308 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -44837,7 +45019,7 @@ paths: type: string enum: - required_linear_history - - &614 + - &616 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -44915,7 +45097,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &307 + - &309 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -44939,7 +45121,7 @@ paths: type: string required: - required_deployment_environments - - &308 + - &310 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -44951,7 +45133,7 @@ paths: type: string enum: - required_signatures - - &309 + - &311 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -45057,7 +45239,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &310 + - &312 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -45105,7 +45287,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &311 + - &313 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -45117,7 +45299,7 @@ paths: type: string enum: - non_fast_forward - - &312 + - &314 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -45154,7 +45336,7 @@ paths: required: - operator - pattern - - &313 + - &315 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -45191,7 +45373,7 @@ paths: required: - operator - pattern - - &314 + - &316 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -45228,7 +45410,7 @@ paths: required: - operator - pattern - - &315 + - &317 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -45265,7 +45447,7 @@ paths: required: - operator - pattern - - &316 + - &318 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -45302,7 +45484,7 @@ paths: required: - operator - pattern - - &317 + - &319 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -45327,7 +45509,7 @@ paths: type: string required: - restricted_file_paths - - &318 + - &320 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -45351,7 +45533,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &319 + - &321 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -45374,7 +45556,7 @@ paths: type: string required: - restricted_file_extensions - - &320 + - &322 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -45399,7 +45581,7 @@ paths: maximum: 100 required: - max_file_size - - &321 + - &323 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -45449,7 +45631,7 @@ paths: - repository_id required: - workflows - - &322 + - &324 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -45510,7 +45692,7 @@ paths: - tool required: - code_scanning_tools - - &323 + - &325 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -45588,7 +45770,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 requestBody: description: Request body required: true @@ -45609,22 +45791,20 @@ paths: - push - repository default: branch - enforcement: *300 + enforcement: *302 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *302 + items: *303 + conditions: *304 rules: type: array description: An array of rules within the ruleset. - items: &326 + items: &328 title: Repository Rule type: object description: A repository rule. oneOf: - - *303 - - *304 - *305 - *306 - *307 @@ -45644,6 +45824,8 @@ paths: - *321 - *322 - *323 + - *324 + - *325 required: - name - enforcement @@ -45681,9 +45863,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: &325 + default: &327 value: id: 21 name: super cool ruleset @@ -45738,8 +45920,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *76 - - &617 + - *78 + - &619 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -45754,7 +45936,7 @@ paths: in: query schema: type: string - - &618 + - &620 name: time_period description: |- The time period to filter by. @@ -45770,14 +45952,14 @@ paths: - week - month default: day - - &619 + - &621 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &620 + - &622 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45797,7 +45979,7 @@ paths: description: Response content: application/json: - schema: &621 + schema: &623 title: Rule Suites description: Response type: array @@ -45852,7 +46034,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &622 + default: &624 value: - id: 21 actor_id: 12 @@ -45895,8 +46077,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *76 - - &623 + - *78 + - &625 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45912,7 +46094,7 @@ paths: description: Response content: application/json: - schema: &624 + schema: &626 title: Rule Suite description: Response type: object @@ -46011,7 +46193,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &625 + default: &627 value: id: 21 actor_id: 12 @@ -46072,7 +46254,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46084,9 +46266,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: *325 + default: *327 '404': *6 '500': *55 put: @@ -46104,7 +46286,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46130,16 +46312,16 @@ paths: - tag - push - repository - enforcement: *300 + enforcement: *302 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *302 + items: *303 + conditions: *304 rules: description: An array of rules within the ruleset. type: array - items: *326 + items: *328 examples: default: value: @@ -46174,9 +46356,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: *325 + default: *327 '404': *6 '422': *15 '500': *55 @@ -46195,7 +46377,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46218,7 +46400,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *76 + - *78 - *17 - *19 - name: ruleset_id @@ -46234,7 +46416,7 @@ paths: application/json: schema: type: array - items: &327 + items: &329 title: Ruleset version type: object description: The historical version of a ruleset @@ -46258,7 +46440,7 @@ paths: type: string format: date-time examples: - default: &627 + default: &629 value: - version_id: 3 actor: @@ -46293,7 +46475,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46311,9 +46493,9 @@ paths: description: Response content: application/json: - schema: &628 + schema: &630 allOf: - - *327 + - *329 - type: object required: - state @@ -46382,8 +46564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *76 - - &629 + - *78 + - &631 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -46394,7 +46576,7 @@ paths: enum: - open - resolved - - &630 + - &632 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -46404,7 +46586,7 @@ paths: required: false schema: type: string - - &631 + - &633 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -46415,7 +46597,7 @@ paths: required: false schema: type: string - - &632 + - &634 name: exclude_providers in: query description: |- @@ -46426,7 +46608,7 @@ paths: required: false schema: type: string - - &633 + - &635 name: providers in: query description: |- @@ -46437,7 +46619,7 @@ paths: required: false schema: type: string - - &634 + - &636 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46446,7 +46628,7 @@ paths: required: false schema: type: string - - &635 + - &637 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46465,7 +46647,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &636 + - &638 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -46480,7 +46662,7 @@ paths: - *62 - *19 - *17 - - &637 + - &639 name: before 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 @@ -46490,7 +46672,7 @@ paths: required: false schema: type: string - - &638 + - &640 name: after 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 @@ -46500,7 +46682,7 @@ paths: required: false schema: type: string - - &639 + - &641 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46509,7 +46691,7 @@ paths: required: false schema: type: string - - &640 + - &642 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46518,7 +46700,7 @@ paths: schema: type: boolean default: false - - &641 + - &643 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46527,7 +46709,7 @@ paths: schema: type: boolean default: false - - &642 + - &644 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -46546,8 +46728,8 @@ paths: items: type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -46555,21 +46737,21 @@ paths: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &643 + state: &645 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &644 + resolution: &646 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -46686,8 +46868,8 @@ paths: pull request. ' - oneOf: &645 - - &647 + oneOf: &647 + - &649 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -46745,7 +46927,7 @@ paths: - blob_url - commit_sha - commit_url - - &648 + - &650 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -46800,7 +46982,7 @@ paths: - page_url - commit_sha - commit_url - - &649 + - &651 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -46820,7 +47002,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &650 + - &652 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -46840,7 +47022,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &651 + - &653 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -46860,7 +47042,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &652 + - &654 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -46874,7 +47056,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &653 + - &655 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -46888,7 +47070,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &654 + - &656 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -46902,7 +47084,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &655 + - &657 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -46922,7 +47104,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &656 + - &658 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -46942,7 +47124,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &657 + - &659 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -46962,7 +47144,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &658 + - &660 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -46982,7 +47164,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &659 + - &661 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -47206,9 +47388,9 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47233,7 +47415,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *78 responses: '200': description: Response @@ -47245,7 +47427,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &329 + pattern_config_version: &331 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -47254,7 +47436,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &328 + items: &330 type: object properties: token_type: @@ -47320,7 +47502,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *328 + items: *330 examples: default: value: @@ -47369,7 +47551,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *78 requestBody: required: true content: @@ -47377,7 +47559,7 @@ paths: schema: type: object properties: - pattern_config_version: *329 + pattern_config_version: *331 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -47403,7 +47585,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *329 + custom_pattern_version: *331 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -47457,7 +47639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *76 + - *78 - *62 - name: sort description: The property to sort the results by. @@ -47501,7 +47683,7 @@ paths: application/json: schema: type: array - items: &663 + items: &665 description: A repository security advisory. type: object properties: @@ -47721,7 +47903,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *332 credits_detailed: type: array nullable: true @@ -47731,7 +47913,7 @@ paths: type: object properties: user: *4 - type: *330 + type: *332 state: type: string description: The state of the user's acceptance of the @@ -47755,7 +47937,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *195 + items: *197 private_fork: readOnly: true nullable: true @@ -47792,7 +47974,7 @@ paths: - private_fork additionalProperties: false examples: - default: &664 + default: &666 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -48171,7 +48353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *76 + - *78 responses: '200': description: Response @@ -48179,7 +48361,7 @@ paths: application/json: schema: type: array - items: *331 + items: *333 examples: default: value: @@ -48219,8 +48401,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -48245,8 +48427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -48273,7 +48455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Immutable releases settings response @@ -48322,7 +48504,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -48379,7 +48561,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *76 + - *78 - *19 - *17 responses: @@ -48397,9 +48579,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48418,7 +48600,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *76 + - *78 requestBody: required: true content: @@ -48467,8 +48649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -48490,8 +48672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -48514,7 +48696,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -48532,7 +48714,7 @@ paths: type: integer network_configurations: type: array - items: &332 + items: &334 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -48603,7 +48785,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48622,7 +48804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -48678,9 +48860,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *334 examples: - default: &333 + default: &335 value: id: 123456789ABCDEF name: My network configuration @@ -48708,8 +48890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 - - &334 + - *78 + - &336 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -48721,11 +48903,11 @@ paths: description: Response content: application/json: - schema: *332 + schema: *334 examples: - default: *333 + default: *335 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48744,8 +48926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 - - *334 + - *78 + - *336 requestBody: required: true content: @@ -48798,9 +48980,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *334 examples: - default: *333 + default: *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48819,8 +49001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *76 - - *334 + - *78 + - *336 responses: '204': description: Response @@ -48843,7 +49025,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *76 + - *78 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -48897,7 +49079,7 @@ paths: subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" region: eastus headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48927,8 +49109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *76 - *78 + - *80 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -48960,13 +49142,13 @@ paths: application/json: schema: type: array - items: *335 + items: *337 examples: - default: *336 + default: *338 '500': *55 '403': *29 '404': *6 - '422': *337 + '422': *339 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48984,7 +49166,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *76 + - *78 - *17 - *19 - name: team_type @@ -49006,11 +49188,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -49030,7 +49212,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *76 + - *78 requestBody: required: true content: @@ -49102,7 +49284,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &340 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -49165,8 +49347,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *259 + required: *260 nullable: true members_count: type: integer @@ -49429,7 +49611,7 @@ paths: - repos_count - organization examples: - default: &339 + default: &341 value: id: 1 node_id: MDQ6VGVhbTE= @@ -49499,16 +49681,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *76 - *78 + - *80 responses: '200': description: Response content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '404': *6 x-github: githubCloudOnly: false @@ -49529,8 +49711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *76 - *78 + - *80 requestBody: required: false content: @@ -49592,16 +49774,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '201': description: Response content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '404': *6 '422': *15 '403': *29 @@ -49626,12 +49808,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response - '422': &340 + '422': &342 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -49654,8 +49836,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -49665,12 +49847,12 @@ paths: application/json: schema: type: array - items: *236 + items: *238 examples: - default: *237 + default: *239 headers: - Link: *68 - '422': *340 + Link: *70 + '422': *342 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49690,8 +49872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *76 - *78 + - *80 - name: role description: Filters members returned by their role in the team. in: query @@ -49714,9 +49896,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49744,15 +49926,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 responses: '200': description: Response content: application/json: - schema: &341 + schema: &343 title: Team Membership description: Team Membership type: object @@ -49779,7 +49961,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &679 + response-if-user-is-a-team-maintainer: &681 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -49815,9 +49997,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 requestBody: required: false content: @@ -49842,9 +50024,9 @@ paths: description: Response content: application/json: - schema: *341 + schema: *343 examples: - response-if-users-membership-with-team-is-now-pending: &680 + response-if-users-membership-with-team-is-now-pending: &682 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -49879,9 +50061,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 responses: '204': description: Response @@ -49907,8 +50089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -49918,11 +50100,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49949,16 +50131,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *76 - *78 - - *342 - - *343 + - *80 + - *344 + - *345 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &681 + schema: &683 title: Team Repository description: A team's access to a repository. type: object @@ -49981,8 +50163,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true forks: type: integer @@ -50527,10 +50709,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *76 - *78 - - *342 - - *343 + - *80 + - *344 + - *345 requestBody: required: false content: @@ -50575,10 +50757,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *76 - *78 - - *342 - - *343 + - *80 + - *344 + - *345 responses: '204': description: Response @@ -50602,8 +50784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -50613,9 +50795,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - response-if-child-teams-exist: &682 + response-if-child-teams-exist: &684 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -50643,7 +50825,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50668,7 +50850,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *76 + - *78 - name: security_product in: path description: The security feature to enable or disable. @@ -50769,7 +50951,7 @@ paths: resources: type: object properties: - core: &344 + core: &346 title: Rate Limit type: object properties: @@ -50786,21 +50968,21 @@ paths: - remaining - reset - used - graphql: *344 - search: *344 - code_search: *344 - source_import: *344 - integration_manifest: *344 - code_scanning_upload: *344 - actions_runner_registration: *344 - scim: *344 - dependency_snapshots: *344 - dependency_sbom: *344 - code_scanning_autofix: *344 + graphql: *346 + search: *346 + code_search: *346 + source_import: *346 + integration_manifest: *346 + code_scanning_upload: *346 + actions_runner_registration: *346 + scim: *346 + dependency_snapshots: *346 + dependency_sbom: *346 + code_scanning_autofix: *346 required: - core - search - rate: *344 + rate: *346 required: - rate - resources @@ -50905,14 +51087,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *345 + schema: *347 examples: default-response: summary: Default response @@ -51417,7 +51599,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *346 + '301': *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51435,8 +51617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -51734,10 +51916,10 @@ paths: description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 - '307': &348 + default: *349 + '307': &350 description: Temporary Redirect content: application/json: @@ -51766,8 +51948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -51789,7 +51971,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *348 + '307': *350 '404': *6 '409': *54 x-github: @@ -51813,11 +51995,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 - - &381 + - &383 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -51840,7 +52022,7 @@ paths: type: integer artifacts: type: array - items: &349 + items: &351 title: Artifact description: An artifact type: object @@ -51918,7 +52100,7 @@ paths: - expires_at - updated_at examples: - default: &382 + default: &384 value: total_count: 2 artifacts: @@ -51957,7 +52139,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51979,9 +52161,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *342 - - *343 - - &350 + - *344 + - *345 + - &352 name: artifact_id description: The unique identifier of the artifact. in: path @@ -51993,7 +52175,7 @@ paths: description: Response content: application/json: - schema: *349 + schema: *351 examples: default: value: @@ -52031,9 +52213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *342 - - *343 - - *350 + - *344 + - *345 + - *352 responses: '204': description: Response @@ -52057,9 +52239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *342 - - *343 - - *350 + - *344 + - *345 + - *352 - name: archive_format in: path required: true @@ -52069,11 +52251,11 @@ paths: '302': description: Response headers: - Location: &504 + Location: &506 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &545 + '410': &547 description: Gone content: application/json: @@ -52098,14 +52280,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &351 + schema: &353 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -52138,13 +52320,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *351 + schema: *353 examples: selected_actions: *42 responses: @@ -52173,14 +52355,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &352 + schema: &354 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -52213,13 +52395,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *352 + schema: *354 examples: selected_actions: *44 responses: @@ -52250,14 +52432,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *353 + schema: *355 examples: default: value: @@ -52283,11 +52465,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 - - &354 + - &356 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -52321,7 +52503,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &357 title: Repository actions caches description: Repository actions caches type: object @@ -52363,7 +52545,7 @@ paths: - total_count - actions_caches examples: - default: &356 + default: &358 value: total_count: 1 actions_caches: @@ -52375,7 +52557,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52395,23 +52577,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *342 - - *343 + - *344 + - *345 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *354 + - *356 responses: '200': description: Response content: application/json: - schema: *355 + schema: *357 examples: - default: *356 + default: *358 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52431,8 +52613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *342 - - *343 + - *344 + - *345 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -52463,9 +52645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *342 - - *343 - - &357 + - *344 + - *345 + - &359 name: job_id description: The unique identifier of the job. in: path @@ -52477,7 +52659,7 @@ paths: description: Response content: application/json: - schema: &385 + schema: &387 title: Job description: Information of a job execution in a workflow run type: object @@ -52784,9 +52966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *342 - - *343 - - *357 + - *344 + - *345 + - *359 responses: '302': description: Response @@ -52814,9 +52996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *342 - - *343 - - *357 + - *344 + - *345 + - *359 requestBody: required: false content: @@ -52837,7 +53019,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -52861,8 +53043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Status response @@ -52883,6 +53065,15 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable + OIDC subject claim format. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. If not set at the + repository level, falls back to the organization-level setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default examples: @@ -52912,8 +53103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -52935,6 +53126,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -52947,7 +53143,7 @@ paths: description: Empty response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -52976,8 +53172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -52995,7 +53191,7 @@ paths: type: integer secrets: type: array - items: &387 + items: &389 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -53015,7 +53211,7 @@ paths: - created_at - updated_at examples: - default: &388 + default: &390 value: total_count: 2 secrets: @@ -53026,7 +53222,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53048,9 +53244,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *342 - - *343 - - *358 + - *344 + - *345 + - *360 - *19 responses: '200': @@ -53067,7 +53263,7 @@ paths: type: integer variables: type: array - items: &391 + items: &393 title: Actions Variable type: object properties: @@ -53097,7 +53293,7 @@ paths: - created_at - updated_at examples: - default: &392 + default: &394 value: total_count: 2 variables: @@ -53110,7 +53306,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53130,8 +53326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -53140,12 +53336,12 @@ paths: schema: type: object properties: - enabled: &360 + enabled: &362 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *144 - selected_actions_url: *359 - sha_pinning_required: *145 + allowed_actions: *146 + selected_actions_url: *361 + sha_pinning_required: *147 required: - enabled examples: @@ -53173,8 +53369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -53185,9 +53381,9 @@ paths: schema: type: object properties: - enabled: *360 - allowed_actions: *144 - sha_pinning_required: *145 + enabled: *362 + allowed_actions: *146 + sha_pinning_required: *147 required: - enabled examples: @@ -53217,14 +53413,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &361 + schema: &363 type: object properties: access_level: @@ -53241,7 +53437,7 @@ paths: required: - access_level examples: - default: &362 + default: &364 value: access_level: organization x-github: @@ -53265,15 +53461,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *361 + schema: *363 examples: - default: *362 + default: *364 responses: '204': description: Response @@ -53297,14 +53493,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *363 + schema: *365 examples: default: value: @@ -53328,8 +53524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Empty response for successful settings update @@ -53339,7 +53535,7 @@ paths: required: true content: application/json: - schema: *364 + schema: *366 examples: default: summary: Set retention days @@ -53363,16 +53559,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *146 + schema: *148 examples: - default: *365 + default: *367 '404': *6 x-github: enabledForGitHubApps: true @@ -53391,8 +53587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -53402,7 +53598,7 @@ paths: required: true content: application/json: - schema: *146 + schema: *148 examples: default: summary: Set approval policy to first time contributors @@ -53426,16 +53622,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *366 + schema: *368 examples: - default: *147 + default: *149 '403': *29 '404': *6 x-github: @@ -53455,15 +53651,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *367 + schema: *369 examples: - default: *147 + default: *149 responses: '204': description: Empty response for successful settings update @@ -53487,16 +53683,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *149 + schema: *151 examples: - default: *150 + default: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53515,8 +53711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -53524,9 +53720,9 @@ paths: required: false content: application/json: - schema: *149 + schema: *151 examples: - selected_actions: *150 + selected_actions: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53548,16 +53744,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *368 + schema: *370 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53578,8 +53774,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Success response @@ -53590,9 +53786,9 @@ paths: required: true content: application/json: - schema: *369 + schema: *371 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53619,8 +53815,8 @@ paths: in: query schema: type: string - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -53638,11 +53834,11 @@ paths: type: integer runners: type: array - items: *161 + items: *163 examples: - default: *162 + default: *164 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53664,8 +53860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -53673,9 +53869,9 @@ paths: application/json: schema: type: array - items: *370 + items: *372 examples: - default: *371 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53697,8 +53893,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -53741,7 +53937,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *372 + '201': *374 '404': *6 '422': *7 '409': *54 @@ -53772,16 +53968,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: *373 + default: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53809,16 +54005,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: *374 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53840,17 +54036,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 responses: '200': description: Response content: application/json: - schema: *161 + schema: *163 examples: - default: *375 + default: *377 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53871,9 +54067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 responses: '204': description: Response @@ -53899,11 +54095,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 responses: - '200': *165 + '200': *167 '404': *6 x-github: githubCloudOnly: false @@ -53925,9 +54121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 requestBody: required: true content: @@ -53951,7 +54147,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -53975,9 +54171,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 requestBody: required: true content: @@ -54002,7 +54198,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -54026,11 +54222,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 responses: - '200': *376 + '200': *378 '404': *6 x-github: githubCloudOnly: false @@ -54057,12 +54253,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 - - *377 + - *344 + - *345 + - *162 + - *379 responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -54088,9 +54284,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *342 - - *343 - - &395 + - *344 + - *345 + - &397 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -54098,7 +54294,7 @@ paths: required: false schema: type: string - - &396 + - &398 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -54106,7 +54302,7 @@ paths: required: false schema: type: string - - &397 + - &399 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -54115,7 +54311,7 @@ paths: required: false schema: type: string - - &398 + - &400 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -54142,7 +54338,7 @@ paths: - pending - *17 - *19 - - &399 + - &401 name: created 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)." @@ -54151,7 +54347,7 @@ paths: schema: type: string format: date-time - - &378 + - &380 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -54160,13 +54356,13 @@ paths: schema: type: boolean default: false - - &400 + - &402 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &401 + - &403 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -54189,7 +54385,7 @@ paths: type: integer workflow_runs: type: array - items: &379 + items: &381 title: Workflow Run description: An invocation of a workflow type: object @@ -54284,7 +54480,7 @@ paths: that triggered the run. type: array nullable: true - items: *91 + items: *93 created_at: type: string format: date-time @@ -54337,7 +54533,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &423 + properties: &425 id: type: string description: SHA for the commit @@ -54388,7 +54584,7 @@ paths: - name - email nullable: true - required: &424 + required: &426 - id - tree_id - message @@ -54396,8 +54592,8 @@ paths: - author - committer nullable: true - repository: *159 - head_repository: *159 + repository: *161 + head_repository: *161 head_repository_id: type: integer example: 5 @@ -54435,7 +54631,7 @@ paths: - workflow_url - pull_requests examples: - default: &402 + default: &404 value: total_count: 1 workflow_runs: @@ -54649,7 +54845,7 @@ paths: releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54671,24 +54867,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *342 - - *343 - - &380 + - *344 + - *345 + - &382 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *378 + - *380 responses: '200': description: Response content: application/json: - schema: *379 + schema: *381 examples: - default: &383 + default: &385 value: id: 30433642 name: Build @@ -54929,9 +55125,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '204': description: Response @@ -54954,9 +55150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '200': description: Response @@ -55075,15 +55271,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -55110,12 +55306,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 - *17 - *19 - - *381 + - *383 - *62 responses: '200': @@ -55132,11 +55328,11 @@ paths: type: integer artifacts: type: array - items: *349 + items: *351 examples: - default: *382 + default: *384 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55158,25 +55354,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *342 - - *343 - - *380 - - &384 + - *344 + - *345 + - *382 + - &386 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *378 + - *380 responses: '200': description: Response content: application/json: - schema: *379 + schema: *381 examples: - default: *383 + default: *385 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55199,10 +55395,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *342 - - *343 - - *380 - - *384 + - *344 + - *345 + - *382 + - *386 - *17 - *19 responses: @@ -55220,9 +55416,9 @@ paths: type: integer jobs: type: array - items: *385 + items: *387 examples: - default: &386 + default: &388 value: total_count: 1 jobs: @@ -55311,7 +55507,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -55335,10 +55531,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *342 - - *343 - - *380 - - *384 + - *344 + - *345 + - *382 + - *386 responses: '302': description: Response @@ -55366,15 +55562,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '202': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -55401,9 +55597,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 requestBody: required: true content: @@ -55470,15 +55666,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '202': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -55505,9 +55701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -55537,11 +55733,11 @@ paths: type: integer jobs: type: array - items: *385 + items: *387 examples: - default: *386 + default: *388 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55564,9 +55760,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '302': description: Response @@ -55593,9 +55789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '204': description: Response @@ -55622,9 +55818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '200': description: Response @@ -55684,7 +55880,7 @@ paths: items: type: object properties: - type: &511 + type: &513 type: string description: The type of reviewer. enum: @@ -55694,7 +55890,7 @@ paths: reviewer: anyOf: - *4 - - *195 + - *197 required: - environment - wait_timer @@ -55769,9 +55965,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 requestBody: required: true content: @@ -55818,12 +56014,12 @@ paths: application/json: schema: type: array - items: &506 + items: &508 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &752 + properties: &754 url: type: string format: uri @@ -55906,9 +56102,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - required: &753 + properties: *83 + required: *84 + required: &755 - id - node_id - sha @@ -55924,7 +56120,7 @@ paths: - created_at - updated_at examples: - default: &507 + default: &509 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -55980,9 +56176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 requestBody: required: false content: @@ -56003,7 +56199,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56026,9 +56222,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 requestBody: required: false content: @@ -56049,7 +56245,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56081,9 +56277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '200': description: Response @@ -56220,8 +56416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -56239,11 +56435,11 @@ paths: type: integer secrets: type: array - items: *387 + items: *389 examples: - default: *388 + default: *390 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56266,16 +56462,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *389 + schema: *391 examples: - default: *390 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56297,17 +56493,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '200': description: Response content: application/json: - schema: *387 + schema: *389 examples: - default: &524 + default: &526 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -56333,9 +56529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 requestBody: required: true content: @@ -56366,7 +56562,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56392,9 +56588,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '204': description: Response @@ -56419,9 +56615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *342 - - *343 - - *358 + - *344 + - *345 + - *360 - *19 responses: '200': @@ -56438,11 +56634,11 @@ paths: type: integer variables: type: array - items: *391 + items: *393 examples: - default: *392 + default: *394 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56463,8 +56659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -56491,7 +56687,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56516,17 +56712,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *342 - - *343 - - *170 + - *344 + - *345 + - *172 responses: '200': description: Response content: application/json: - schema: *391 + schema: *393 examples: - default: &525 + default: &527 value: name: USERNAME value: octocat @@ -56552,9 +56748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *342 - - *343 - - *170 + - *344 + - *345 + - *172 requestBody: required: true content: @@ -56596,9 +56792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *342 - - *343 - - *170 + - *344 + - *345 + - *172 responses: '204': description: Response @@ -56623,8 +56819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -56642,7 +56838,7 @@ paths: type: integer workflows: type: array - items: &393 + items: &395 title: Workflow description: A GitHub Actions workflow type: object @@ -56726,7 +56922,7 @@ paths: html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56749,9 +56945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *342 - - *343 - - &394 + - *344 + - *345 + - &396 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -56766,7 +56962,7 @@ paths: description: Response content: application/json: - schema: *393 + schema: *395 examples: default: value: @@ -56799,9 +56995,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *342 - - *343 - - *394 + - *344 + - *345 + - *396 responses: '204': description: Response @@ -56826,9 +57022,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *342 - - *343 - - *394 + - *344 + - *345 + - *396 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -56915,9 +57111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *342 - - *343 - - *394 + - *344 + - *345 + - *396 responses: '204': description: Response @@ -56944,19 +57140,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *342 - - *343 - - *394 - - *395 + - *344 + - *345 - *396 - *397 - *398 - - *17 - - *19 - *399 - - *378 - *400 + - *17 + - *19 - *401 + - *380 + - *402 + - *403 responses: '200': description: Response @@ -56972,11 +57168,11 @@ paths: type: integer workflow_runs: type: array - items: *379 + items: *381 examples: - default: *402 + default: *404 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57006,9 +57202,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *342 - - *343 - - *394 + - *344 + - *345 + - *396 responses: '200': description: Response @@ -57069,8 +57265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *342 - - *343 + - *344 + - *345 - *62 - *17 - *47 @@ -57215,7 +57411,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '422': *7 x-github: githubCloudOnly: false @@ -57234,8 +57430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -57247,9 +57443,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -57272,8 +57468,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *342 - - *343 + - *344 + - *345 - name: assignee in: path required: true @@ -57309,8 +57505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -57420,8 +57616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *47 - *48 @@ -57478,7 +57674,7 @@ paths: initiator: type: string examples: - default: *403 + default: *405 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57498,8 +57694,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -57507,7 +57703,7 @@ paths: application/json: schema: type: array - items: &404 + items: &406 title: Autolink reference description: An autolink reference. type: object @@ -57561,8 +57757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -57601,9 +57797,9 @@ paths: description: response content: application/json: - schema: *404 + schema: *406 examples: - default: &405 + default: &407 value: id: 1 key_prefix: TICKET- @@ -57634,9 +57830,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *342 - - *343 - - &406 + - *344 + - *345 + - &408 name: autolink_id description: The unique identifier of the autolink. in: path @@ -57648,9 +57844,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *406 examples: - default: *405 + default: *407 '404': *6 x-github: githubCloudOnly: false @@ -57670,9 +57866,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *342 - - *343 - - *406 + - *344 + - *345 + - *408 responses: '204': description: Response @@ -57696,8 +57892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response if Dependabot is enabled @@ -57745,8 +57941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -57767,8 +57963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -57788,8 +57984,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *342 - - *343 + - *344 + - *345 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -57827,7 +58023,7 @@ paths: - url protected: type: boolean - protection: &408 + protection: &410 title: Branch Protection description: Branch Protection type: object @@ -57869,7 +58065,7 @@ paths: required: - contexts - checks - enforce_admins: &411 + enforce_admins: &413 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -57884,7 +58080,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &413 + required_pull_request_reviews: &415 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -57905,7 +58101,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *195 + items: *197 apps: description: The list of apps with review dismissal access. @@ -57934,7 +58130,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *195 + items: *197 apps: description: The list of apps allowed to bypass pull request requirements. @@ -57960,7 +58156,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &410 + restrictions: &412 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -58023,7 +58219,7 @@ paths: type: string teams: type: array - items: *195 + items: *197 apps: type: array items: @@ -58219,7 +58415,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -58237,9 +58433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *342 - - *343 - - &409 + - *344 + - *345 + - &411 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -58253,14 +58449,14 @@ paths: description: Response content: application/json: - schema: &419 + schema: &421 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &476 + commit: &478 title: Commit description: Commit type: object @@ -58294,7 +58490,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &407 + properties: &409 name: type: string example: '"Chris Wanstrath"' @@ -58310,7 +58506,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *409 nullable: true message: type: string @@ -58331,7 +58527,7 @@ paths: required: - sha - url - verification: &531 + verification: &533 title: Verification type: object properties: @@ -58365,12 +58561,12 @@ paths: nullable: true oneOf: - *4 - - *168 + - *170 committer: nullable: true oneOf: - *4 - - *168 + - *170 parents: type: array items: @@ -58401,7 +58597,7 @@ paths: type: integer files: type: array - items: &489 + items: &491 title: Diff Entry description: Diff Entry type: object @@ -58485,7 +58681,7 @@ paths: - self protected: type: boolean - protection: *408 + protection: *410 protection_url: type: string format: uri @@ -58592,7 +58788,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *346 + '301': *348 '404': *6 x-github: githubCloudOnly: false @@ -58614,15 +58810,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *408 + schema: *410 examples: default: value: @@ -58816,9 +59012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -59073,7 +59269,7 @@ paths: url: type: string format: uri - required_status_checks: &416 + required_status_checks: &418 title: Status Check Policy description: Status Check Policy type: object @@ -59149,7 +59345,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 apps: type: array items: *5 @@ -59167,7 +59363,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 apps: type: array items: *5 @@ -59225,7 +59421,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *410 + restrictions: *412 required_conversation_resolution: type: object properties: @@ -59337,9 +59533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59364,17 +59560,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *411 + schema: *413 examples: - default: &412 + default: &414 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -59396,17 +59592,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *411 + schema: *413 examples: - default: *412 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59425,9 +59621,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59452,17 +59648,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *413 + schema: *415 examples: - default: &414 + default: &416 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -59558,9 +59754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -59658,9 +59854,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *415 examples: - default: *414 + default: *416 '422': *15 x-github: githubCloudOnly: false @@ -59681,9 +59877,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59710,17 +59906,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *411 + schema: *413 examples: - default: &415 + default: &417 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -59743,17 +59939,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *411 + schema: *413 examples: - default: *415 + default: *417 '404': *6 x-github: githubCloudOnly: false @@ -59773,9 +59969,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59800,17 +59996,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *416 + schema: *418 examples: - default: &417 + default: &419 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -59836,9 +60032,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -59890,9 +60086,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *418 examples: - default: *417 + default: *419 '404': *6 '422': *15 x-github: @@ -59914,9 +60110,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59940,9 +60136,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response @@ -59976,9 +60172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -60045,9 +60241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -60111,9 +60307,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: content: application/json: @@ -60179,15 +60375,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *410 + schema: *412 examples: default: value: @@ -60278,9 +60474,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -60303,9 +60499,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response @@ -60315,7 +60511,7 @@ paths: type: array items: *5 examples: - default: &418 + default: &420 value: - id: 1 slug: octoapp @@ -60372,9 +60568,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60408,7 +60604,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *420 '422': *15 x-github: githubCloudOnly: false @@ -60429,9 +60625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60465,7 +60661,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *420 '422': *15 x-github: githubCloudOnly: false @@ -60486,9 +60682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60522,7 +60718,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *420 '422': *15 x-github: githubCloudOnly: false @@ -60544,9 +60740,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response @@ -60554,9 +60750,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 '404': *6 x-github: githubCloudOnly: false @@ -60576,9 +60772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -60614,9 +60810,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 '422': *15 x-github: githubCloudOnly: false @@ -60637,9 +60833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -60675,9 +60871,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 '422': *15 x-github: githubCloudOnly: false @@ -60698,9 +60894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: content: application/json: @@ -60735,9 +60931,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 '422': *15 x-github: githubCloudOnly: false @@ -60759,9 +60955,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response @@ -60771,7 +60967,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '404': *6 x-github: githubCloudOnly: false @@ -60795,9 +60991,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60830,7 +61026,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -60855,9 +61051,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60890,7 +61086,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -60915,9 +61111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60950,7 +61146,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -60977,9 +61173,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -61001,7 +61197,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *421 examples: default: value: @@ -61117,8 +61313,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -61397,7 +61593,7 @@ paths: description: Response content: application/json: - schema: &420 + schema: &422 title: CheckRun description: A check performed on the code of a given code change type: object @@ -61508,16 +61704,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *91 - deployment: &745 + items: *93 + deployment: &747 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -61584,8 +61780,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -61797,9 +61993,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *342 - - *343 - - &421 + - *344 + - *345 + - &423 name: check_run_id description: The unique identifier of the check run. in: path @@ -61811,9 +62007,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *422 examples: - default: &422 + default: &424 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -61913,9 +62109,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *342 - - *343 - - *421 + - *344 + - *345 + - *423 requestBody: required: true content: @@ -62155,9 +62351,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *422 examples: - default: *422 + default: *424 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62177,9 +62373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *342 - - *343 - - *421 + - *344 + - *345 + - *423 - *17 - *19 responses: @@ -62254,7 +62450,7 @@ paths: raw_details: Do you mean 'bananas' or 'banana'? blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62274,15 +62470,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *342 - - *343 - - *421 + - *344 + - *345 + - *423 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -62320,8 +62516,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -62343,7 +62539,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &425 + schema: &427 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -62407,7 +62603,7 @@ paths: nullable: true pull_requests: type: array - items: *91 + items: *93 nullable: true app: title: GitHub app @@ -62418,9 +62614,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - repository: *159 + properties: *83 + required: *84 + repository: *161 created_at: type: string format: date-time @@ -62429,12 +62625,12 @@ paths: type: string format: date-time nullable: true - head_commit: &773 + head_commit: &775 title: Simple Commit description: A commit. type: object - properties: *423 - required: *424 + properties: *425 + required: *426 latest_check_runs_count: type: integer check_runs_url: @@ -62462,7 +62658,7 @@ paths: - check_runs_url - pull_requests examples: - default: &426 + default: &428 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -62753,9 +62949,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *425 + schema: *427 examples: - default: *426 + default: *428 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62774,8 +62970,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -62836,7 +63032,7 @@ paths: required: - app_id - setting - repository: *159 + repository: *161 examples: default: value: @@ -63084,9 +63280,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *342 - - *343 - - &427 + - *344 + - *345 + - &429 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -63098,9 +63294,9 @@ paths: description: Response content: application/json: - schema: *425 + schema: *427 examples: - default: *426 + default: *428 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63123,17 +63319,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *342 - - *343 - - *427 - - &482 + - *344 + - *345 + - *429 + - &484 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &483 + - &485 name: status description: Returns check runs with the specified `status`. in: query @@ -63172,9 +63368,9 @@ paths: type: integer check_runs: type: array - items: *420 + items: *422 examples: - default: &484 + default: &486 value: total_count: 1 check_runs: @@ -63256,7 +63452,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63276,15 +63472,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *342 - - *343 - - *427 + - *344 + - *345 + - *429 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -63311,21 +63507,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *342 - - *343 - - *428 - - *429 + - *344 + - *345 + - *430 + - *431 - *19 - *17 - - &446 + - &448 name: ref 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`. in: query required: false - schema: *430 - - &447 + schema: *432 + - &449 name: pr description: The number of the pull request for the results you want to list. in: query @@ -63350,13 +63546,13 @@ paths: be returned. in: query required: false - schema: *431 + schema: *433 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *432 + schema: *434 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -63375,14 +63571,14 @@ paths: items: type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: *433 - state: *186 - fixed_at: *182 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: *435 + state: *188 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -63390,12 +63586,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: *434 - dismissed_comment: *435 - rule: *436 - tool: *437 - most_recent_instance: *438 + dismissed_at: *185 + dismissed_reason: *436 + dismissed_comment: *437 + rule: *438 + tool: *439 + most_recent_instance: *440 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -63521,14 +63717,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &439 + '403': &441 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63548,9 +63744,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *342 - - *343 - - &440 + - *344 + - *345 + - &442 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -63558,23 +63754,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *177 + schema: *179 responses: '200': description: Response content: application/json: - schema: &441 + schema: &443 type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: *433 - state: *186 - fixed_at: *182 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: *435 + state: *188 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -63582,9 +63778,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: *434 - dismissed_comment: *435 + dismissed_at: *185 + dismissed_reason: *436 + dismissed_comment: *437 rule: type: object properties: @@ -63638,8 +63834,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *437 - most_recent_instance: *438 + tool: *439 + most_recent_instance: *440 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -63738,9 +63934,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63758,9 +63954,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 requestBody: required: true content: @@ -63775,8 +63971,8 @@ paths: enum: - open - dismissed - dismissed_reason: *434 - dismissed_comment: *435 + dismissed_reason: *436 + dismissed_comment: *437 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -63804,7 +64000,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *443 examples: default: value: @@ -63880,14 +64076,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &445 + '403': &447 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63907,15 +64103,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 responses: '200': description: Response content: application/json: - schema: &442 + schema: &444 type: object properties: status: @@ -63941,13 +64137,13 @@ paths: - description - started_at examples: - default: &443 + default: &445 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &444 + '400': &446 description: Bad Request content: application/json: @@ -63958,9 +64154,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63983,29 +64179,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 responses: '200': description: OK content: application/json: - schema: *442 + schema: *444 examples: - default: *443 + default: *445 '202': description: Accepted content: application/json: - schema: *442 + schema: *444 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *444 + '400': *446 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -64015,7 +64211,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64037,9 +64233,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 requestBody: required: false content: @@ -64084,12 +64280,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *444 - '403': *445 + '400': *446 + '403': *447 '404': *6 '422': description: Unprocessable Entity - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64109,13 +64305,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 - *19 - *17 - - *446 - - *447 + - *448 + - *449 responses: '200': description: Response @@ -64126,10 +64322,10 @@ paths: items: type: object properties: - ref: *430 - analysis_key: *448 - environment: *449 - category: *450 + ref: *432 + analysis_key: *450 + environment: *451 + category: *452 state: type: string description: State of a code scanning alert instance. @@ -64144,7 +64340,7 @@ paths: properties: text: type: string - location: *451 + location: *453 html_url: type: string classifications: @@ -64152,7 +64348,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *452 + items: *454 examples: default: value: @@ -64189,9 +64385,9 @@ paths: end_column: 50 classifications: - source - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64223,25 +64419,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *342 - - *343 - - *428 - - *429 + - *344 + - *345 + - *430 + - *431 - *19 - *17 - - *447 + - *449 - name: ref in: query description: The Git reference for the analyses 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`. required: false - schema: *430 + schema: *432 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &453 + schema: &455 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -64262,23 +64458,23 @@ paths: application/json: schema: type: array - items: &454 + items: &456 type: object properties: - ref: *430 - commit_sha: &462 + ref: *432 + commit_sha: &464 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *448 + analysis_key: *450 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *450 + category: *452 error: type: string example: error reading field xyz @@ -64302,8 +64498,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *453 - tool: *437 + sarif_id: *455 + tool: *439 deletable: type: boolean warning: @@ -64364,9 +64560,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64400,8 +64596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64414,7 +64610,7 @@ paths: description: Response content: application/json: - schema: *454 + schema: *456 examples: response: summary: application/json response @@ -64468,14 +64664,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *439 + '403': *441 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64555,8 +64751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64609,9 +64805,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *445 + '403': *447 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64631,8 +64827,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -64640,7 +64836,7 @@ paths: application/json: schema: type: array - items: &455 + items: &457 title: CodeQL Database description: A CodeQL database. type: object @@ -64751,9 +64947,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64780,8 +64976,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: language in: path description: The language of the CodeQL database. @@ -64793,7 +64989,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *457 examples: default: value: @@ -64825,11 +65021,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &493 + '302': &495 description: Found - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64849,8 +65045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *342 - - *343 + - *344 + - *345 - name: language in: path description: The language of the CodeQL database. @@ -64860,9 +65056,9 @@ paths: responses: '204': description: Response - '403': *445 + '403': *447 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64888,8 +65084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -64898,7 +65094,7 @@ paths: type: object additionalProperties: false properties: - language: &456 + language: &458 type: string description: The language targeted by the CodeQL query enum: @@ -64978,7 +65174,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &460 + schema: &462 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -64988,7 +65184,7 @@ paths: description: The ID of the variant analysis. controller_repo: *67 actor: *4 - query_language: *456 + query_language: *458 query_pack_url: type: string description: The download url for the query pack. @@ -65035,7 +65231,7 @@ paths: items: type: object properties: - repository: &457 + repository: &459 title: Repository Identifier description: Repository Identifier type: object @@ -65071,7 +65267,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &461 + analysis_status: &463 type: string description: The new status of the CodeQL variant analysis repository task. @@ -65103,7 +65299,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &458 + access_mismatch_repos: &460 type: object properties: repository_count: @@ -65117,7 +65313,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *457 + items: *459 required: - repository_count - repositories @@ -65139,8 +65335,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *458 - over_limit_repos: *458 + no_codeql_db_repos: *460 + over_limit_repos: *460 required: - access_mismatch_repos - not_found_repos @@ -65156,7 +65352,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &459 + value: &461 summary: Default response value: id: 1 @@ -65302,17 +65498,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *459 + value: *461 repository_lists: summary: Response for a successful variant analysis submission - value: *459 + value: *461 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65333,8 +65529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *342 - - *343 + - *344 + - *345 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -65346,11 +65542,11 @@ paths: description: Response content: application/json: - schema: *460 + schema: *462 examples: - default: *459 + default: *461 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65371,7 +65567,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *342 + - *344 - name: repo in: path description: The name of the controller repository. @@ -65406,7 +65602,7 @@ paths: type: object properties: repository: *67 - analysis_status: *461 + analysis_status: *463 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -65510,7 +65706,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65531,8 +65727,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -65617,9 +65813,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65638,8 +65834,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -65706,7 +65902,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -65731,7 +65927,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *445 + '403': *447 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -65745,7 +65941,7 @@ paths: content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65802,8 +65998,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -65811,7 +66007,7 @@ paths: schema: type: object properties: - commit_sha: *462 + commit_sha: *464 ref: type: string description: |- @@ -65869,7 +66065,7 @@ paths: schema: type: object properties: - id: *453 + id: *455 url: type: string description: The REST API URL for checking the status of the upload. @@ -65883,11 +66079,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *445 + '403': *447 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65906,8 +66102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *342 - - *343 + - *344 + - *345 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -65953,10 +66149,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *439 + '403': *441 '404': description: Not Found if the sarif id does not match any upload - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65978,8 +66174,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -66060,8 +66256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *342 - - *343 + - *344 + - *345 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -66181,8 +66377,8 @@ paths: parameters: - *17 - *19 - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -66198,7 +66394,7 @@ paths: type: integer codespaces: type: array - items: *247 + items: *249 examples: default: value: @@ -66496,8 +66692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -66560,22 +66756,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66599,8 +66795,8 @@ paths: parameters: - *17 - *19 - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -66664,8 +66860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -66700,14 +66896,14 @@ paths: type: integer machines: type: array - items: &688 + items: &690 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *464 - required: *465 + properties: *466 + required: *467 examples: - default: &689 + default: &691 value: total_count: 2 machines: @@ -66747,8 +66943,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *342 - - *343 + - *344 + - *345 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -66832,8 +67028,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *342 - - *343 + - *344 + - *345 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -66878,7 +67074,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66899,8 +67095,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -66918,7 +67114,7 @@ paths: type: integer secrets: type: array - items: &469 + items: &471 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -66938,9 +67134,9 @@ paths: - created_at - updated_at examples: - default: *466 + default: *468 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66961,16 +67157,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66990,17 +67186,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '200': description: Response content: application/json: - schema: *469 + schema: *471 examples: - default: *470 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67020,9 +67216,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 requestBody: required: true content: @@ -67050,7 +67246,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -67074,9 +67270,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '204': description: Response @@ -67104,8 +67300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *342 - - *343 + - *344 + - *345 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -67147,7 +67343,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &471 + properties: &473 login: type: string example: octocat @@ -67240,7 +67436,7 @@ paths: user_view_type: type: string example: public - required: &472 + required: &474 - avatar_url - events_url - followers_url @@ -67289,7 +67485,7 @@ paths: admin: false role_name: write headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -67314,9 +67510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *342 - - *343 - - *72 + - *344 + - *345 + - *74 responses: '204': description: Response if user is a collaborator @@ -67362,9 +67558,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *342 - - *343 - - *72 + - *344 + - *345 + - *74 requestBody: required: false content: @@ -67390,7 +67586,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &544 + schema: &546 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -67401,7 +67597,7 @@ paths: example: 42 type: integer format: int64 - repository: *159 + repository: *161 invitee: title: Simple User description: A GitHub user. @@ -67579,7 +67775,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *128 + schema: *130 '403': *29 x-github: triggersNotification: true @@ -67619,9 +67815,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *342 - - *343 - - *72 + - *344 + - *345 + - *74 responses: '204': description: No Content when collaborator was removed from the repository. @@ -67652,9 +67848,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *342 - - *343 - - *72 + - *344 + - *345 + - *74 responses: '200': description: if user has admin permissions @@ -67674,8 +67870,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *471 - required: *472 + properties: *473 + required: *474 nullable: true required: - permission @@ -67730,8 +67926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -67741,7 +67937,7 @@ paths: application/json: schema: type: array - items: &473 + items: &475 title: Commit Comment description: Commit Comment type: object @@ -67782,8 +67978,8 @@ paths: updated_at: type: string format: date-time - author_association: *83 - reactions: *84 + author_association: *85 + reactions: *86 required: - url - html_url @@ -67799,7 +67995,7 @@ paths: - created_at - updated_at examples: - default: &478 + default: &480 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67833,7 +68029,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67858,17 +68054,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '200': description: Response content: application/json: - schema: *473 + schema: *475 examples: - default: &479 + default: &481 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67925,9 +68121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -67949,7 +68145,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *475 examples: default: value: @@ -68000,9 +68196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '204': description: Response @@ -68023,9 +68219,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -68051,7 +68247,7 @@ paths: application/json: schema: type: array - items: &474 + items: &476 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -68094,7 +68290,7 @@ paths: - content - created_at examples: - default: &548 + default: &550 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -68120,7 +68316,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -68139,9 +68335,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -68173,9 +68369,9 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *476 examples: - default: &475 + default: &477 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -68204,9 +68400,9 @@ paths: description: Reaction created content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -68228,10 +68424,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *342 - - *343 - - *102 - - &549 + - *344 + - *345 + - *104 + - &551 name: reaction_id description: The unique identifier of the reaction. in: path @@ -68286,8 +68482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *342 - - *343 + - *344 + - *345 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -68343,9 +68539,9 @@ paths: application/json: schema: type: array - items: *476 + items: *478 examples: - default: &600 + default: &602 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -68415,7 +68611,7 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *68 + Link: *70 '500': *55 '400': *14 '404': *6 @@ -68439,9 +68635,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *342 - - *343 - - &477 + - *344 + - *345 + - &479 name: commit_sha description: The SHA of the commit. in: path @@ -68513,9 +68709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *342 - - *343 - - *477 + - *344 + - *345 + - *479 - *17 - *19 responses: @@ -68525,11 +68721,11 @@ paths: application/json: schema: type: array - items: *473 + items: *475 examples: - default: *478 + default: *480 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68555,9 +68751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *342 - - *343 - - *477 + - *344 + - *345 + - *479 requestBody: required: true content: @@ -68592,9 +68788,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *475 examples: - default: *479 + default: *481 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68622,9 +68818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *342 - - *343 - - *477 + - *344 + - *345 + - *479 - *17 - *19 responses: @@ -68634,9 +68830,9 @@ paths: application/json: schema: type: array - items: *480 + items: *482 examples: - default: &592 + default: &594 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -69115,7 +69311,7 @@ paths: auto_merge: draft: false headers: - Link: *68 + Link: *70 '409': *54 x-github: githubCloudOnly: false @@ -69173,11 +69369,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *342 - - *343 + - *344 + - *345 - *19 - *17 - - &481 + - &483 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -69192,9 +69388,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *478 examples: - default: &579 + default: &581 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69282,7 +69478,7 @@ paths: schema: type: string examples: - default: &490 + default: &492 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -69295,7 +69491,7 @@ paths: schema: type: string examples: - default: &491 + default: &493 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -69322,7 +69518,7 @@ paths: '422': *15 '404': *6 '500': *55 - '503': *120 + '503': *122 '409': *54 x-github: githubCloudOnly: false @@ -69348,11 +69544,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *342 - - *343 - - *481 - - *482 + - *344 + - *345 - *483 + - *484 + - *485 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -69386,11 +69582,11 @@ paths: type: integer check_runs: type: array - items: *420 + items: *422 examples: - default: *484 + default: *486 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69413,9 +69609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *342 - - *343 - - *481 + - *344 + - *345 + - *483 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -69423,7 +69619,7 @@ paths: schema: type: integer example: 1 - - *482 + - *484 - *17 - *19 responses: @@ -69441,7 +69637,7 @@ paths: type: integer check_suites: type: array - items: *425 + items: *427 examples: default: value: @@ -69616,7 +69812,7 @@ paths: latest_check_runs_count: 1 check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69641,9 +69837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *342 - - *343 - - *481 + - *344 + - *345 + - *483 - *17 - *19 responses: @@ -69710,7 +69906,7 @@ paths: type: string total_count: type: integer - repository: *159 + repository: *161 commit_url: type: string format: uri @@ -69841,9 +70037,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *342 - - *343 - - *481 + - *344 + - *345 + - *483 - *17 - *19 responses: @@ -69853,7 +70049,7 @@ paths: application/json: schema: type: array - items: &668 + items: &670 title: Status description: The status of a commit. type: object @@ -69933,8 +70129,8 @@ paths: type: User site_admin: false headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69962,8 +70158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -69992,20 +70188,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *485 - required: *486 + properties: *487 + required: *488 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &487 + properties: &489 url: type: string format: uri html_url: type: string format: uri - required: &488 + required: &490 - url - html_url nullable: true @@ -70013,32 +70209,32 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true contributing: title: Community Health File type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true readme: title: Community Health File type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true issue_template: title: Community Health File type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true pull_request_template: title: Community Health File type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true required: - code_of_conduct @@ -70165,8 +70361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *342 - - *343 + - *344 + - *345 - *19 - *17 - name: basehead @@ -70209,8 +70405,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *476 - merge_base_commit: *476 + base_commit: *478 + merge_base_commit: *478 status: type: string enum: @@ -70230,10 +70426,10 @@ paths: example: 6 commits: type: array - items: *476 + items: *478 files: type: array - items: *489 + items: *491 required: - url - html_url @@ -70479,15 +70675,15 @@ paths: schema: type: string examples: - default: *490 + default: *492 application/vnd.github.patch: schema: type: string examples: - default: *491 + default: *493 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70529,8 +70725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *342 - - *343 + - *344 + - *345 - name: path description: path parameter in: path @@ -70690,7 +70886,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &492 + response-if-content-is-a-file-github-object: &494 summary: Response if content is a file value: type: file @@ -70822,7 +71018,7 @@ paths: - size - type - url - - &605 + - &607 title: Content File description: Content File type: object @@ -71023,7 +71219,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *492 + response-if-content-is-a-file: *494 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -71092,7 +71288,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *493 + '302': *495 '304': *37 x-github: githubCloudOnly: false @@ -71115,8 +71311,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *342 - - *343 + - *344 + - *345 - name: path description: path parameter in: path @@ -71209,7 +71405,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &496 title: File Commit description: File Commit type: object @@ -71361,7 +71557,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *496 examples: example-for-creating-a-file: value: @@ -71415,7 +71611,7 @@ paths: schema: oneOf: - *3 - - &526 + - &528 description: Repository rule violation was detected type: object properties: @@ -71436,7 +71632,7 @@ paths: items: type: object properties: - placeholder_id: &660 + placeholder_id: &662 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -71468,8 +71664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *342 - - *343 + - *344 + - *345 - name: path description: path parameter in: path @@ -71530,7 +71726,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *496 examples: default: value: @@ -71565,7 +71761,7 @@ paths: '422': *15 '404': *6 '409': *54 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71585,8 +71781,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *342 - - *343 + - *344 + - *345 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -71686,7 +71882,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *68 + Link: *70 '204': description: Response if repository is empty '403': *29 @@ -71709,24 +71905,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *342 - - *343 - - *197 - - *198 + - *344 + - *345 - *199 - *200 - *201 + - *202 + - *203 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *202 - - *495 - - *203 - *204 + - *497 - *205 + - *206 + - *207 - *62 - *47 - *48 @@ -71738,11 +71934,11 @@ paths: application/json: schema: type: array - items: &499 + items: &501 type: object description: A Dependabot alert. properties: - number: *177 + number: *179 state: type: string description: The state of the Dependabot alert. @@ -71785,13 +71981,13 @@ paths: - direct - transitive - inconclusive - security_advisory: *496 + security_advisory: *498 security_vulnerability: *66 - url: *180 - html_url: *181 - created_at: *178 - updated_at: *179 - dismissed_at: *183 + url: *182 + html_url: *183 + created_at: *180 + updated_at: *181 + dismissed_at: *185 dismissed_by: title: Simple User description: A GitHub user. @@ -71815,9 +72011,9 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *182 - auto_dismissed_at: *497 - dismissal_request: *498 + fixed_at: *184 + auto_dismissed_at: *499 + dismissal_request: *500 assignees: type: array description: The users assigned to this alert. @@ -72072,9 +72268,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *342 - - *343 - - &500 + - *344 + - *345 + - &502 name: alert_number in: path description: |- @@ -72083,13 +72279,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *177 + schema: *179 responses: '200': description: Response content: application/json: - schema: *499 + schema: *501 examples: default: value: @@ -72221,9 +72417,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *342 - - *343 - - *500 + - *344 + - *345 + - *502 requestBody: required: true content: @@ -72279,7 +72475,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *501 examples: default: value: @@ -72409,8 +72605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -72428,7 +72624,7 @@ paths: type: integer secrets: type: array - items: &503 + items: &505 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -72459,7 +72655,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72481,16 +72677,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *501 + schema: *503 examples: - default: *502 + default: *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72510,15 +72706,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '200': description: Response content: application/json: - schema: *503 + schema: *505 examples: default: value: @@ -72544,9 +72740,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 requestBody: required: true content: @@ -72574,7 +72770,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -72598,9 +72794,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '204': description: Response @@ -72622,8 +72818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *342 - - *343 + - *344 + - *345 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -72759,7 +72955,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *68 + Link: *70 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -72783,8 +72979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -73000,7 +73196,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *68 + Link: *70 '404': *6 '403': *29 x-github: @@ -73022,8 +73218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: sbom_uuid in: path required: true @@ -73034,7 +73230,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *504 + Location: *506 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -73055,8 +73251,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '201': description: Response @@ -73094,8 +73290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -73170,7 +73366,7 @@ paths: - version - url additionalProperties: false - metadata: &505 + metadata: &507 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -73203,7 +73399,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *505 + metadata: *507 resolved: type: object description: A collection of resolved package dependencies. @@ -73216,7 +73412,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *505 + metadata: *507 relationship: type: string description: A notation of whether a dependency is requested @@ -73345,8 +73541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *342 - - *343 + - *344 + - *345 - name: sha description: The SHA recorded at creation time. in: query @@ -73386,11 +73582,11 @@ paths: application/json: schema: type: array - items: *506 + items: *508 examples: - default: *507 + default: *509 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73454,8 +73650,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -73536,7 +73732,7 @@ paths: description: Response content: application/json: - schema: *506 + schema: *508 examples: simple-example: summary: Simple example @@ -73609,9 +73805,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *342 - - *343 - - &508 + - *344 + - *345 + - &510 name: deployment_id description: deployment_id parameter in: path @@ -73623,7 +73819,7 @@ paths: description: Response content: application/json: - schema: *506 + schema: *508 examples: default: value: @@ -73688,9 +73884,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *342 - - *343 - - *508 + - *344 + - *345 + - *510 responses: '204': description: Response @@ -73712,9 +73908,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *342 - - *343 - - *508 + - *344 + - *345 + - *510 - *17 - *19 responses: @@ -73724,7 +73920,7 @@ paths: application/json: schema: type: array - items: &509 + items: &511 title: Deployment Status description: The status of a deployment. type: object @@ -73815,8 +74011,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -73865,7 +74061,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -73885,9 +74081,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *342 - - *343 - - *508 + - *344 + - *345 + - *510 requestBody: required: true content: @@ -73962,9 +74158,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *511 examples: - default: &510 + default: &512 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -74020,9 +74216,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *342 - - *343 - - *508 + - *344 + - *345 + - *510 - name: status_id in: path required: true @@ -74033,9 +74229,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *511 examples: - default: *510 + default: *512 '404': *6 x-github: githubCloudOnly: false @@ -74060,8 +74256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -74118,8 +74314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -74136,7 +74332,7 @@ paths: type: integer environments: type: array - items: &512 + items: &514 title: Environment description: Details of a deployment environment type: object @@ -74188,7 +74384,7 @@ paths: type: type: string example: wait_timer - wait_timer: &514 + wait_timer: &516 type: integer example: 30 description: The amount of time to delay a job after @@ -74225,11 +74421,11 @@ paths: items: type: object properties: - type: *511 + type: *513 reviewer: anyOf: - *4 - - *195 + - *197 required: - id - node_id @@ -74249,7 +74445,7 @@ paths: - id - node_id - type - deployment_branch_policy: &515 + deployment_branch_policy: &517 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -74365,9 +74561,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *342 - - *343 - - &513 + - *344 + - *345 + - &515 name: environment_name in: path required: true @@ -74380,9 +74576,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *514 examples: - default: &516 + default: &518 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -74466,9 +74662,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 requestBody: required: false content: @@ -74477,7 +74673,7 @@ paths: type: object nullable: true properties: - wait_timer: *514 + wait_timer: *516 prevent_self_review: type: boolean example: false @@ -74494,13 +74690,13 @@ paths: items: type: object properties: - type: *511 + type: *513 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *515 + deployment_branch_policy: *517 additionalProperties: false examples: default: @@ -74520,9 +74716,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *514 examples: - default: *516 + default: *518 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -74546,9 +74742,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 responses: '204': description: Default response @@ -74573,9 +74769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 - *17 - *19 responses: @@ -74593,7 +74789,7 @@ paths: example: 2 branch_policies: type: array - items: &517 + items: &519 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -74650,9 +74846,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 requestBody: required: true content: @@ -74698,9 +74894,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *519 examples: - example-wildcard: &518 + example-wildcard: &520 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -74742,10 +74938,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *342 - - *343 - - *513 - - &519 + - *344 + - *345 + - *515 + - &521 name: branch_policy_id in: path required: true @@ -74757,9 +74953,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *519 examples: - default: *518 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74778,10 +74974,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *342 - - *343 - - *513 - - *519 + - *344 + - *345 + - *515 + - *521 requestBody: required: true content: @@ -74809,9 +75005,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *519 examples: - default: *518 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74830,10 +75026,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *342 - - *343 - - *513 - - *519 + - *344 + - *345 + - *515 + - *521 responses: '204': description: Response @@ -74858,9 +75054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *513 - - *343 - - *342 + - *515 + - *345 + - *344 responses: '200': description: List of deployment protection rules @@ -74876,7 +75072,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &520 + items: &522 title: Deployment protection rule description: Deployment protection rule type: object @@ -74895,7 +75091,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &521 + app: &523 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -74994,9 +75190,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *513 - - *343 - - *342 + - *515 + - *345 + - *344 requestBody: content: application/json: @@ -75017,9 +75213,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *520 + schema: *522 examples: - default: &522 + default: &524 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -75054,9 +75250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *513 - - *343 - - *342 + - *515 + - *345 + - *344 - *19 - *17 responses: @@ -75075,7 +75271,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *521 + items: *523 examples: default: value: @@ -75110,10 +75306,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *342 - - *343 - - *513 - - &523 + - *344 + - *345 + - *515 + - &525 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -75125,9 +75321,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *522 examples: - default: *522 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75148,10 +75344,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *513 - - *343 - - *342 - - *523 + - *515 + - *345 + - *344 + - *525 responses: '204': description: Response @@ -75177,9 +75373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 - *17 - *19 responses: @@ -75197,11 +75393,11 @@ paths: type: integer secrets: type: array - items: *387 + items: *389 examples: - default: *388 + default: *390 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75224,17 +75420,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 responses: '200': description: Response content: application/json: - schema: *389 + schema: *391 examples: - default: *390 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75256,18 +75452,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *342 - - *343 - - *513 - - *167 + - *344 + - *345 + - *515 + - *169 responses: '200': description: Response content: application/json: - schema: *387 + schema: *389 examples: - default: *524 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75289,10 +75485,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *342 - - *343 - - *513 - - *167 + - *344 + - *345 + - *515 + - *169 requestBody: required: true content: @@ -75323,7 +75519,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -75349,10 +75545,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *342 - - *343 - - *513 - - *167 + - *344 + - *345 + - *515 + - *169 responses: '204': description: Default response @@ -75377,10 +75573,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *342 - - *343 - - *513 - - *358 + - *344 + - *345 + - *515 + - *360 - *19 responses: '200': @@ -75397,11 +75593,11 @@ paths: type: integer variables: type: array - items: *391 + items: *393 examples: - default: *392 + default: *394 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75422,9 +75618,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 requestBody: required: true content: @@ -75451,7 +75647,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -75476,18 +75672,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *342 - - *343 - - *513 - - *170 + - *344 + - *345 + - *515 + - *172 responses: '200': description: Response content: application/json: - schema: *391 + schema: *393 examples: - default: *525 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75508,10 +75704,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *342 - - *343 - - *170 - - *513 + - *344 + - *345 + - *172 + - *515 requestBody: required: true content: @@ -75553,10 +75749,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *342 - - *343 - - *170 - - *513 + - *344 + - *345 + - *172 + - *515 responses: '204': description: Response @@ -75578,8 +75774,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -75589,7 +75785,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: 200-response: value: @@ -75647,8 +75843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *342 - - *343 + - *344 + - *345 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -75670,7 +75866,7 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: default: value: @@ -75783,7 +75979,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *68 + Link: *70 '400': *14 x-github: githubCloudOnly: false @@ -75807,8 +76003,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -75840,9 +76036,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 + default: *349 '400': *14 '422': *15 '403': *29 @@ -75863,8 +76059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -75923,8 +76119,8 @@ paths: application/json: schema: oneOf: - - *128 - - *526 + - *130 + - *528 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75949,8 +76145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *342 - - *343 + - *344 + - *345 - name: file_sha in: path required: true @@ -76049,8 +76245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -76159,7 +76355,7 @@ paths: description: Response content: application/json: - schema: &527 + schema: &529 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -76373,15 +76569,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *342 - - *343 - - *477 + - *344 + - *345 + - *479 responses: '200': description: Response content: application/json: - schema: *527 + schema: *529 examples: default: value: @@ -76437,9 +76633,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *342 - - *343 - - &528 + - *344 + - *345 + - &530 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -76456,7 +76652,7 @@ paths: application/json: schema: type: array - items: &529 + items: &531 title: Git Reference description: Git references within a repository type: object @@ -76509,7 +76705,7 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *68 + Link: *70 '409': *54 x-github: githubCloudOnly: false @@ -76531,17 +76727,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *342 - - *343 - - *528 + - *344 + - *345 + - *530 responses: '200': description: Response content: application/json: - schema: *529 + schema: *531 examples: - default: &530 + default: &532 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -76570,8 +76766,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -76600,9 +76796,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *531 examples: - default: *530 + default: *532 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -76628,9 +76824,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *342 - - *343 - - *528 + - *344 + - *345 + - *530 requestBody: required: true content: @@ -76659,9 +76855,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *531 examples: - default: *530 + default: *532 '422': *15 '409': *54 x-github: @@ -76679,9 +76875,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *342 - - *343 - - *528 + - *344 + - *345 + - *530 responses: '204': description: Response @@ -76736,8 +76932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -76804,7 +77000,7 @@ paths: description: Response content: application/json: - schema: &532 + schema: &534 title: Git Tag description: Metadata for a Git tag type: object @@ -76855,7 +77051,7 @@ paths: - sha - type - url - verification: *531 + verification: *533 required: - sha - url @@ -76865,7 +77061,7 @@ paths: - tag - message examples: - default: &533 + default: &535 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -76938,8 +77134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *342 - - *343 + - *344 + - *345 - name: tag_sha in: path required: true @@ -76950,9 +77146,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *534 examples: - default: *533 + default: *535 '404': *6 '409': *54 x-github: @@ -76976,8 +77172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -77050,7 +77246,7 @@ paths: description: Response content: application/json: - schema: &534 + schema: &536 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -77146,8 +77342,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *342 - - *343 + - *344 + - *345 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -77170,7 +77366,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *536 examples: default-response: summary: Default response @@ -77229,8 +77425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -77240,7 +77436,7 @@ paths: application/json: schema: type: array - items: &535 + items: &537 title: Webhook description: Webhooks for repositories. type: object @@ -77294,7 +77490,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &781 + last_response: &783 title: Hook Response type: object properties: @@ -77349,7 +77545,7 @@ paths: status: unused message: headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -77368,8 +77564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -77421,9 +77617,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: &536 + default: &538 value: type: Repository id: 12345678 @@ -77471,17 +77667,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '200': description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: *536 + default: *538 '404': *6 x-github: githubCloudOnly: false @@ -77501,9 +77697,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 requestBody: required: true content: @@ -77548,9 +77744,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: *536 + default: *538 '422': *15 '404': *6 x-github: @@ -77571,9 +77767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '204': description: Response @@ -77597,9 +77793,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '200': description: Response @@ -77626,9 +77822,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 requestBody: required: false content: @@ -77672,12 +77868,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *342 - - *343 - - *215 - - *17 - - *216 + - *344 + - *345 - *217 + - *17 + - *218 + - *219 responses: '200': description: Response @@ -77685,9 +77881,9 @@ paths: application/json: schema: type: array - items: *218 + items: *220 examples: - default: *219 + default: *221 '400': *14 '422': *15 x-github: @@ -77706,18 +77902,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 - *16 responses: '200': description: Response content: application/json: - schema: *220 + schema: *222 examples: - default: *221 + default: *223 '400': *14 '422': *15 x-github: @@ -77736,9 +77932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 - *16 responses: '202': *39 @@ -77761,9 +77957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '204': description: Response @@ -77788,9 +77984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '204': description: Response @@ -77813,8 +78009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response if immutable releases are enabled @@ -77860,8 +78056,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': *61 '409': *54 @@ -77881,8 +78077,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': *61 '409': *54 @@ -77939,14 +78135,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &537 + schema: &539 title: Import description: A repository import from an external source. type: object @@ -78045,7 +78241,7 @@ paths: - html_url - authors_url examples: - default: &540 + default: &542 value: vcs: subversion use_lfs: true @@ -78061,7 +78257,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &538 + '503': &540 description: Unavailable due to service under maintenance. content: application/json: @@ -78090,8 +78286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -78139,7 +78335,7 @@ paths: description: Response content: application/json: - schema: *537 + schema: *539 examples: default: value: @@ -78164,7 +78360,7 @@ paths: type: string '422': *15 '404': *6 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78192,8 +78388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -78242,7 +78438,7 @@ paths: description: Response content: application/json: - schema: *537 + schema: *539 examples: example-1: summary: Example 1 @@ -78290,7 +78486,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78313,12 +78509,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78344,9 +78540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *342 - - *343 - - &710 + - *344 + - *345 + - &712 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -78360,7 +78556,7 @@ paths: application/json: schema: type: array - items: &539 + items: &541 title: Porter Author description: Porter Author type: object @@ -78414,7 +78610,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78439,8 +78635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *342 - - *343 + - *344 + - *345 - name: author_id in: path required: true @@ -78470,7 +78666,7 @@ paths: description: Response content: application/json: - schema: *539 + schema: *541 examples: default: value: @@ -78483,7 +78679,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78507,8 +78703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -78549,7 +78745,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78577,8 +78773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -78605,11 +78801,11 @@ paths: description: Response content: application/json: - schema: *537 + schema: *539 examples: - default: *540 + default: *542 '422': *15 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78632,8 +78828,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -78641,8 +78837,8 @@ paths: application/json: schema: *22 examples: - default: *541 - '301': *346 + default: *543 + '301': *348 '404': *6 x-github: githubCloudOnly: false @@ -78662,8 +78858,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -78671,12 +78867,12 @@ paths: application/json: schema: anyOf: - - *234 + - *236 - type: object properties: {} additionalProperties: false examples: - default: &543 + default: &545 value: limit: collaborators_only origin: repository @@ -78701,13 +78897,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *542 + schema: *544 examples: default: summary: Example request body @@ -78719,9 +78915,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *236 examples: - default: *543 + default: *545 '409': description: Response x-github: @@ -78743,8 +78939,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -78767,8 +78963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -78778,9 +78974,9 @@ paths: application/json: schema: type: array - items: *544 + items: *546 examples: - default: &703 + default: &705 value: - id: 1 repository: @@ -78894,7 +79090,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78911,9 +79107,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *342 - - *343 - - *238 + - *344 + - *345 + - *240 requestBody: required: false content: @@ -78942,7 +79138,7 @@ paths: description: Response content: application/json: - schema: *544 + schema: *546 examples: default: value: @@ -79073,9 +79269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *342 - - *343 - - *238 + - *344 + - *345 + - *240 responses: '204': description: Response @@ -79106,8 +79302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *342 - - *343 + - *344 + - *345 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -79155,7 +79351,7 @@ paths: required: false schema: type: string - - *245 + - *247 - name: sort description: What to sort results by. in: query @@ -79168,7 +79364,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -79178,9 +79374,9 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: &556 + default: &558 value: - id: 1 node_id: MDU6SXNzdWUx @@ -79328,8 +79524,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '422': *15 '404': *6 x-github: @@ -79358,8 +79554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -79441,9 +79637,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: &553 + default: &555 value: id: 1 node_id: MDU6SXNzdWUx @@ -79598,9 +79794,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *120 + '503': *122 '404': *6 - '410': *545 + '410': *547 x-github: triggersNotification: true githubCloudOnly: false @@ -79628,9 +79824,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *342 - - *343 - - *110 + - *344 + - *345 + - *112 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -79640,7 +79836,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -79650,9 +79846,9 @@ paths: application/json: schema: type: array - items: *546 + items: *548 examples: - default: &555 + default: &557 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79683,7 +79879,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '422': *15 '404': *6 x-github: @@ -79710,17 +79906,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '200': description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: &547 + default: &549 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79775,9 +79971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -79799,9 +79995,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: *547 + default: *549 '422': *15 x-github: githubCloudOnly: false @@ -79819,9 +80015,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '204': description: Response @@ -79849,15 +80045,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '200': description: Response content: application/json: - schema: *546 + schema: *548 examples: default: value: @@ -79913,7 +80109,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *545 + '410': *547 '422': *15 x-github: githubCloudOnly: false @@ -79930,17 +80126,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '204': description: Response '401': *25 '403': *29 '404': *6 - '410': *545 - '503': *120 + '410': *547 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79957,9 +80153,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -79985,11 +80181,11 @@ paths: application/json: schema: type: array - items: *474 + items: *476 examples: - default: *548 + default: *550 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -80008,9 +80204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -80042,16 +80238,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '201': description: Reaction created content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -80073,10 +80269,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *342 - - *343 - - *102 - - *549 + - *344 + - *345 + - *104 + - *551 responses: '204': description: Response @@ -80096,8 +80292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -80107,7 +80303,7 @@ paths: application/json: schema: type: array - items: &552 + items: &554 title: Issue Event description: Issue Event type: object @@ -80150,8 +80346,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *550 - required: *551 + properties: *552 + required: *553 nullable: true label: title: Issue Event Label @@ -80195,7 +80391,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *195 + requested_team: *197 dismissed_review: title: Issue Event Dismissed Review type: object @@ -80260,7 +80456,7 @@ paths: required: - from - to - author_association: *83 + author_association: *85 lock_reason: type: string nullable: true @@ -80273,8 +80469,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -80441,7 +80637,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -80459,8 +80655,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *342 - - *343 + - *344 + - *345 - name: event_id in: path required: true @@ -80471,7 +80667,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *554 examples: default: value: @@ -80664,7 +80860,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *545 + '410': *547 '403': *29 x-github: githubCloudOnly: false @@ -80698,9 +80894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *342 - - *343 - - &554 + - *344 + - *345 + - &556 name: issue_number description: The number that identifies the issue. in: path @@ -80712,11 +80908,11 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: default: summary: Issue - value: *553 + value: *555 pinned_comment: summary: Issue with pinned comment value: @@ -80915,9 +81111,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *346 + '301': *348 '404': *6 - '410': *545 + '410': *547 '304': *37 x-github: githubCloudOnly: false @@ -80942,9 +81138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -81068,15 +81264,15 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 '422': *15 - '503': *120 + '503': *122 '403': *29 - '301': *346 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81094,9 +81290,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -81122,9 +81318,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81140,9 +81336,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: content: application/json: @@ -81167,9 +81363,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81191,9 +81387,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - name: assignee in: path required: true @@ -81233,10 +81429,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *342 - - *343 - - *554 - - *93 + - *344 + - *345 + - *556 + - *95 - *17 - *19 responses: @@ -81246,13 +81442,13 @@ paths: application/json: schema: type: array - items: *546 + items: *548 examples: - default: *555 + default: *557 headers: - Link: *68 + Link: *70 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81281,9 +81477,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -81305,16 +81501,16 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: *547 + default: *549 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *545 + '410': *547 '422': *15 '404': *6 x-github: @@ -81342,9 +81538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -81354,14 +81550,14 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *556 + default: *558 headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81389,9 +81585,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -81413,17 +81609,17 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *346 + '301': *348 '403': *29 - '410': *545 + '410': *547 '422': *15 '404': *6 x-github: @@ -81454,9 +81650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -81468,15 +81664,15 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 - '301': *346 + default: *555 + '301': *348 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *545 + '410': *547 x-github: triggersNotification: true githubCloudOnly: false @@ -81502,9 +81698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -81514,14 +81710,14 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *556 + default: *558 headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81538,9 +81734,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -81554,7 +81750,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &560 + - &562 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -81585,8 +81781,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 label: type: object properties: @@ -81608,7 +81804,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &561 + - &563 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -81639,8 +81835,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 label: type: object properties: @@ -81728,8 +81924,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 assigner: *4 required: @@ -81744,7 +81940,7 @@ paths: - performed_via_github_app - assignee - assigner - - &562 + - &564 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -81775,8 +81971,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 milestone: type: object properties: @@ -81795,7 +81991,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &563 + - &565 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -81826,8 +82022,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 milestone: type: object properties: @@ -81846,7 +82042,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &564 + - &566 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -81877,8 +82073,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 rename: type: object properties: @@ -81900,7 +82096,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &567 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -81931,10 +82127,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 review_requester: *4 - requested_team: *195 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -81947,7 +82143,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &568 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -81978,10 +82174,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 review_requester: *4 - requested_team: *195 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -81994,7 +82190,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &569 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -82025,8 +82221,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 dismissed_review: type: object properties: @@ -82054,7 +82250,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &570 title: Locked Issue Event description: Locked Issue Event type: object @@ -82085,8 +82281,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 lock_reason: type: string example: '"off-topic"' @@ -82102,7 +82298,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &569 + - &571 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -82133,8 +82329,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -82168,7 +82364,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &570 + - &572 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -82199,8 +82395,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -82234,7 +82430,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &571 + - &573 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -82265,8 +82461,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -82300,7 +82496,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &572 + - &574 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -82390,8 +82586,8 @@ paths: name: label color: red headers: - Link: *68 - '410': *545 + Link: *70 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82408,9 +82604,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -82420,9 +82616,9 @@ paths: application/json: schema: type: array - items: *557 + items: *559 examples: - default: &558 + default: &560 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -82445,10 +82641,10 @@ paths: data_type: date value: '2025-12-25' headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82477,9 +82673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -82543,14 +82739,14 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *557 + items: *559 examples: - default: *558 + default: *560 '400': *14 '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -82581,9 +82777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -82648,14 +82844,14 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *557 + items: *559 examples: - default: *558 + default: *560 '400': *14 '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -82681,17 +82877,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *342 - - *343 - - *554 - - *241 + - *344 + - *345 + - *556 + - *243 responses: '204': description: Issue field value deleted successfully '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -82709,9 +82905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -82721,9 +82917,9 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: &559 + default: &561 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82740,10 +82936,10 @@ paths: color: a2eeef default: false headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82759,9 +82955,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -82804,12 +83000,12 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *559 - '301': *346 + default: *561 + '301': *348 '404': *6 - '410': *545 + '410': *547 '422': *15 x-github: githubCloudOnly: false @@ -82826,9 +83022,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -82888,12 +83084,12 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *559 - '301': *346 + default: *561 + '301': *348 '404': *6 - '410': *545 + '410': *547 '422': *15 x-github: githubCloudOnly: false @@ -82910,15 +83106,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 responses: '204': description: Response - '301': *346 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82937,9 +83133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - name: name in: path required: true @@ -82952,7 +83148,7 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: default: value: @@ -82963,9 +83159,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *346 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82985,9 +83181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -83015,7 +83211,7 @@ paths: '204': description: Response '403': *29 - '410': *545 + '410': *547 '404': *6 '422': *15 x-github: @@ -83033,9 +83229,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 responses: '204': description: Response @@ -83065,20 +83261,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 responses: '200': description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 - '301': *346 + default: *555 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83095,9 +83291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -83123,13 +83319,13 @@ paths: application/json: schema: type: array - items: *474 + items: *476 examples: - default: *548 + default: *550 headers: - Link: *68 + Link: *70 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83147,9 +83343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -83181,16 +83377,16 @@ paths: description: Response content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '201': description: Response content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -83212,10 +83408,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *342 - - *343 - - *554 - - *549 + - *344 + - *345 + - *556 + - *551 responses: '204': description: Response @@ -83244,9 +83440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -83268,9 +83464,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -83303,9 +83499,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -83315,13 +83511,13 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *556 + default: *558 headers: - Link: *68 + Link: *70 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83349,9 +83545,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -83378,16 +83574,16 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *545 + '410': *547 '422': *15 '404': *6 x-github: @@ -83407,9 +83603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -83440,13 +83636,13 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 '403': *29 '404': *6 '422': *7 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -83464,9 +83660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -83481,8 +83677,6 @@ paths: description: Timeline Event type: object anyOf: - - *560 - - *561 - *562 - *563 - *564 @@ -83494,6 +83688,8 @@ paths: - *570 - *571 - *572 + - *573 + - *574 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -83536,7 +83732,7 @@ paths: issue_url: type: string format: uri - author_association: *83 + author_association: *85 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -83546,16 +83742,16 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - reactions: *84 + properties: *83 + required: *84 + reactions: *86 pin: title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *573 - required: *574 + properties: *575 + required: *576 nullable: true required: - event @@ -83587,7 +83783,7 @@ paths: properties: type: type: string - issue: *86 + issue: *88 required: - event - created_at @@ -83787,7 +83983,7 @@ paths: type: string body_text: type: string - author_association: *83 + author_association: *85 required: - event - id @@ -83810,7 +84006,7 @@ paths: type: string comments: type: array - items: &594 + items: &596 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -83905,7 +84101,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *83 + author_association: *85 _links: type: object properties: @@ -83989,7 +84185,7 @@ paths: enum: - line - file - reactions: *84 + reactions: *86 body_html: type: string example: '"

comment body

"' @@ -84025,7 +84221,7 @@ paths: type: string comments: type: array - items: *473 + items: *475 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -84056,8 +84252,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 required: - id @@ -84100,8 +84296,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 required: - id @@ -84144,8 +84340,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 state_reason: type: string nullable: true @@ -84312,9 +84508,9 @@ paths: type: User site_admin: true headers: - Link: *68 + Link: *70 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84331,8 +84527,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -84342,7 +84538,7 @@ paths: application/json: schema: type: array - items: &575 + items: &577 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -84392,7 +84588,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84408,8 +84604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -84445,9 +84641,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *577 examples: - default: &576 + default: &578 value: id: 1 key: ssh-rsa AAA... @@ -84481,9 +84677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *342 - - *343 - - &577 + - *344 + - *345 + - &579 name: key_id description: The unique identifier of the key. in: path @@ -84495,9 +84691,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *577 examples: - default: *576 + default: *578 '404': *6 x-github: githubCloudOnly: false @@ -84515,9 +84711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *342 - - *343 - - *577 + - *344 + - *345 + - *579 responses: '204': description: Response @@ -84537,8 +84733,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -84548,11 +84744,11 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *559 + default: *561 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -84571,8 +84767,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -84608,9 +84804,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: - default: &578 + default: &580 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -84642,8 +84838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *342 - - *343 + - *344 + - *345 - name: name in: path required: true @@ -84654,9 +84850,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: - default: *578 + default: *580 '404': *6 x-github: githubCloudOnly: false @@ -84673,8 +84869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *342 - - *343 + - *344 + - *345 - name: name in: path required: true @@ -84713,7 +84909,7 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: default: value: @@ -84739,8 +84935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *342 - - *343 + - *344 + - *345 - name: name in: path required: true @@ -84766,8 +84962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -84806,9 +85002,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *342 - - *343 - - *446 + - *344 + - *345 + - *448 responses: '200': description: Response @@ -84870,8 +85066,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true required: - _links @@ -84953,8 +85149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -85019,8 +85215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -85054,9 +85250,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *476 + schema: *478 examples: - default: *579 + default: *581 '204': description: Response when already merged '404': @@ -85081,8 +85277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *342 - - *343 + - *344 + - *345 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -85123,12 +85319,12 @@ paths: application/json: schema: type: array - items: &580 + items: &582 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *281 + required: *282 examples: default: value: @@ -85167,7 +85363,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -85184,8 +85380,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -85225,9 +85421,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *582 examples: - default: &581 + default: &583 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -85286,9 +85482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *342 - - *343 - - &582 + - *344 + - *345 + - &584 name: milestone_number description: The number that identifies the milestone. in: path @@ -85300,9 +85496,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *582 examples: - default: *581 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -85319,9 +85515,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *342 - - *343 - - *582 + - *344 + - *345 + - *584 requestBody: required: false content: @@ -85359,9 +85555,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *582 examples: - default: *581 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85377,9 +85573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *342 - - *343 - - *582 + - *344 + - *345 + - *584 responses: '204': description: Response @@ -85400,9 +85596,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *342 - - *343 - - *582 + - *344 + - *345 + - *584 - *17 - *19 responses: @@ -85412,11 +85608,11 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *559 + default: *561 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85433,12 +85629,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *342 - - *343 - - *583 - - *584 - - *93 + - *344 + - *345 - *585 + - *586 + - *95 + - *587 - *17 - *19 responses: @@ -85448,11 +85644,11 @@ paths: application/json: schema: type: array - items: *113 + items: *115 examples: - default: *586 + default: *588 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -85474,8 +85670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -85533,14 +85729,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &587 + schema: &589 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -85665,7 +85861,7 @@ paths: - custom_404 - public examples: - default: &588 + default: &590 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -85706,8 +85902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -85761,9 +85957,9 @@ paths: description: Response content: application/json: - schema: *587 + schema: *589 examples: - default: *588 + default: *590 '422': *15 '409': *54 x-github: @@ -85786,8 +85982,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -85886,8 +86082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -85913,8 +86109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -85924,7 +86120,7 @@ paths: application/json: schema: type: array - items: &589 + items: &591 title: Page Build description: Page Build type: object @@ -85999,7 +86195,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86018,8 +86214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *342 - - *343 + - *344 + - *345 responses: '201': description: Response @@ -86064,16 +86260,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *589 + schema: *591 examples: - default: &590 + default: &592 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -86121,8 +86317,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *342 - - *343 + - *344 + - *345 - name: build_id in: path required: true @@ -86133,9 +86329,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: - default: *590 + default: *592 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86155,8 +86351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -86261,9 +86457,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *342 - - *343 - - &591 + - *344 + - *345 + - &593 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -86321,9 +86517,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *342 - - *343 - - *591 + - *344 + - *345 + - *593 responses: '204': *61 '404': *6 @@ -86350,8 +86546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -86582,7 +86778,7 @@ paths: description: Empty response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -86609,8 +86805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Private vulnerability reporting status @@ -86647,8 +86843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': *61 '422': *14 @@ -86669,8 +86865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': *61 '422': *14 @@ -86692,8 +86888,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -86701,7 +86897,7 @@ paths: application/json: schema: type: array - items: *294 + items: *296 examples: default: value: @@ -86732,8 +86928,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -86745,7 +86941,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *294 + items: *296 required: - properties examples: @@ -86795,8 +86991,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *342 - - *343 + - *344 + - *345 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -86856,11 +87052,11 @@ paths: application/json: schema: type: array - items: *480 + items: *482 examples: - default: *592 + default: *594 headers: - Link: *68 + Link: *70 '304': *37 '422': *15 x-github: @@ -86890,8 +87086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -86956,7 +87152,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &598 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -87067,8 +87263,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *281 + required: *282 nullable: true active_lock_reason: type: string @@ -87111,7 +87307,7 @@ paths: items: *4 requested_teams: type: array - items: *331 + items: *333 head: type: object properties: @@ -87119,7 +87315,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: *4 @@ -87136,7 +87332,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: *4 @@ -87149,14 +87345,14 @@ paths: _links: type: object properties: - comments: *281 - commits: *281 - statuses: *281 - html: *281 - issue: *281 - review_comments: *281 - review_comment: *281 - self: *281 + comments: *283 + commits: *283 + statuses: *283 + html: *283 + issue: *283 + review_comments: *283 + review_comment: *283 + self: *283 required: - comments - commits @@ -87166,8 +87362,8 @@ paths: - review_comments - review_comment - self - author_association: *83 - auto_merge: *593 + author_association: *85 + auto_merge: *595 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -87259,7 +87455,7 @@ paths: - merged_by - review_comments examples: - default: &597 + default: &599 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -87786,8 +87982,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: sort in: query required: false @@ -87806,7 +88002,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -87816,9 +88012,9 @@ paths: application/json: schema: type: array - items: *594 + items: *596 examples: - default: &599 + default: &601 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87870,7 +88066,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87895,17 +88091,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '200': description: Response content: application/json: - schema: *594 + schema: *596 examples: - default: &595 + default: &597 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87980,9 +88176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -88004,9 +88200,9 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: - default: *595 + default: *597 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88022,9 +88218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '204': description: Response @@ -88045,9 +88241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -88073,11 +88269,11 @@ paths: application/json: schema: type: array - items: *474 + items: *476 examples: - default: *548 + default: *550 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -88096,9 +88292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -88130,16 +88326,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '201': description: Reaction created content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -88161,10 +88357,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *342 - - *343 - - *102 - - *549 + - *344 + - *345 + - *104 + - *551 responses: '204': description: Response @@ -88207,9 +88403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *342 - - *343 - - &598 + - *344 + - *345 + - &600 name: pull_number description: The number that identifies the pull request. in: path @@ -88222,9 +88418,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *596 + schema: *598 examples: - default: *597 + default: *599 '304': *37 '404': *6 '406': @@ -88233,7 +88429,7 @@ paths: application/json: schema: *3 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88259,9 +88455,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -88303,9 +88499,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *598 examples: - default: *597 + default: *599 '422': *15 '403': *29 x-github: @@ -88327,9 +88523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 responses: '204': description: Response @@ -88354,9 +88550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 responses: '204': description: Response @@ -88382,9 +88578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: true content: @@ -88444,21 +88640,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88484,10 +88680,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *342 - - *343 - - *598 - - *110 + - *344 + - *345 + - *600 + - *112 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -88497,7 +88693,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -88507,11 +88703,11 @@ paths: application/json: schema: type: array - items: *594 + items: *596 examples: - default: *599 + default: *601 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88542,9 +88738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: true content: @@ -88649,7 +88845,7 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: example-for-a-multi-line-comment: value: @@ -88737,10 +88933,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *342 - - *343 - - *598 - - *102 + - *344 + - *345 + - *600 + - *104 requestBody: required: true content: @@ -88762,7 +88958,7 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: default: value: @@ -88848,9 +89044,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 - *17 - *19 responses: @@ -88860,11 +89056,11 @@ paths: application/json: schema: type: array - items: *476 + items: *478 examples: - default: *600 + default: *602 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88892,9 +89088,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 - *17 - *19 responses: @@ -88904,7 +89100,7 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: default: value: @@ -88920,10 +89116,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *68 + Link: *70 '422': *15 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88942,9 +89138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 responses: '204': description: Response if pull request has been merged @@ -88967,9 +89163,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -89080,9 +89276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 responses: '200': description: Response @@ -89098,7 +89294,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 required: - users - teams @@ -89139,7 +89335,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89157,9 +89353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -89196,7 +89392,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *482 examples: default: value: @@ -89732,9 +89928,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: true content: @@ -89768,7 +89964,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *482 examples: default: value: @@ -90273,9 +90469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 - *17 - *19 responses: @@ -90285,7 +90481,7 @@ paths: application/json: schema: type: array - items: &601 + items: &603 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -90354,7 +90550,7 @@ paths: type: string body_text: type: string - author_association: *83 + author_association: *85 required: - id - node_id @@ -90403,7 +90599,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90436,9 +90632,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -90524,9 +90720,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: &603 + default: &605 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -90589,10 +90785,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - &602 + - *344 + - *345 + - *600 + - &604 name: review_id description: The unique identifier of the review. in: path @@ -90604,9 +90800,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: &604 + default: &606 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -90665,10 +90861,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 requestBody: required: true content: @@ -90691,7 +90887,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: default: value: @@ -90753,18 +90949,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 responses: '200': description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: *603 + default: *605 '422': *7 '404': *6 x-github: @@ -90791,10 +90987,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 - *17 - *19 responses: @@ -90873,13 +91069,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *83 + author_association: *85 _links: type: object properties: - self: *281 - html: *281 - pull_request: *281 + self: *283 + html: *283 + pull_request: *283 required: - self - html @@ -90888,7 +91084,7 @@ paths: type: string body_html: type: string - reactions: *84 + reactions: *86 side: description: The side of the first line of the range for a multi-line comment. @@ -91000,7 +91196,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -91029,10 +91225,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 requestBody: required: true content: @@ -91060,7 +91256,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: default: value: @@ -91123,10 +91319,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 requestBody: required: true content: @@ -91161,9 +91357,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: *604 + default: *606 '404': *6 '422': *7 '403': *29 @@ -91185,9 +91381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -91250,8 +91446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *342 - - *343 + - *344 + - *345 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -91264,9 +91460,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *607 examples: - default: &606 + default: &608 value: type: file encoding: base64 @@ -91308,8 +91504,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *342 - - *343 + - *344 + - *345 - name: dir description: The alternate path to look for a README file in: path @@ -91329,9 +91525,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *607 examples: - default: *606 + default: *608 '404': *6 '422': *15 x-github: @@ -91353,8 +91549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -91364,7 +91560,7 @@ paths: application/json: schema: type: array - items: *607 + items: *609 examples: default: value: @@ -91438,7 +91634,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -91458,8 +91654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -91535,9 +91731,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: &611 + default: &613 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -91642,9 +91838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *342 - - *343 - - &609 + - *344 + - *345 + - &611 name: asset_id description: The unique identifier of the asset. in: path @@ -91656,9 +91852,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: &610 + default: &612 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -91693,7 +91889,7 @@ paths: type: User site_admin: false '404': *6 - '302': *493 + '302': *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91709,9 +91905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *342 - - *343 - - *609 + - *344 + - *345 + - *611 requestBody: required: false content: @@ -91739,9 +91935,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: *610 + default: *612 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91757,9 +91953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *342 - - *343 - - *609 + - *344 + - *345 + - *611 responses: '204': description: Response @@ -91784,8 +91980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -91870,16 +92066,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': *6 x-github: githubCloudOnly: false @@ -91897,8 +92093,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *342 - - *343 + - *344 + - *345 - name: tag description: tag parameter in: path @@ -91911,9 +92107,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': *6 x-github: githubCloudOnly: false @@ -91935,9 +92131,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *342 - - *343 - - &612 + - *344 + - *345 + - &614 name: release_id description: The unique identifier of the release. in: path @@ -91951,9 +92147,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '401': description: Unauthorized x-github: @@ -91971,9 +92167,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 requestBody: required: false content: @@ -92037,9 +92233,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': description: Not Found if the discussion category name is invalid content: @@ -92060,9 +92256,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 responses: '204': description: Response @@ -92083,9 +92279,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 - *17 - *19 responses: @@ -92095,7 +92291,7 @@ paths: application/json: schema: type: array - items: *608 + items: *610 examples: default: value: @@ -92132,7 +92328,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92176,9 +92372,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 - name: name in: query required: true @@ -92204,7 +92400,7 @@ paths: description: Response for successful upload content: application/json: - schema: *608 + schema: *610 examples: response-for-successful-upload: value: @@ -92259,9 +92455,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -92285,11 +92481,11 @@ paths: application/json: schema: type: array - items: *474 + items: *476 examples: - default: *548 + default: *550 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -92308,9 +92504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 requestBody: required: true content: @@ -92340,16 +92536,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '201': description: Reaction created content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -92371,10 +92567,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *342 - - *343 - - *612 - - *549 + - *344 + - *345 + - *614 + - *551 responses: '204': description: Response @@ -92398,9 +92594,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 - *17 - *19 responses: @@ -92416,8 +92612,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *303 - - &613 + - *305 + - &615 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -92436,69 +92632,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *304 - - *613 - - allOf: - - *305 - - *613 - allOf: - *306 - - *613 - - allOf: - - *614 - - *613 + - *615 - allOf: - *307 - - *613 + - *615 - allOf: - *308 - - *613 + - *615 + - allOf: + - *616 + - *615 - allOf: - *309 - - *613 + - *615 - allOf: - *310 - - *613 + - *615 - allOf: - *311 - - *613 + - *615 - allOf: - *312 - - *613 + - *615 - allOf: - *313 - - *613 + - *615 - allOf: - *314 - - *613 + - *615 - allOf: - *315 - - *613 + - *615 - allOf: - *316 - - *613 + - *615 - allOf: - *317 - - *613 + - *615 - allOf: - *318 - - *613 + - *615 - allOf: - *319 - - *613 + - *615 - allOf: - *320 - - *613 + - *615 - allOf: - *321 - - *613 + - *615 - allOf: - *322 - - *613 + - *615 - allOf: - *323 - - *613 + - *615 + - allOf: + - *324 + - *615 + - allOf: + - *325 + - *615 examples: default: value: @@ -92537,8 +92733,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 - name: includes_parents @@ -92549,7 +92745,7 @@ paths: schema: type: boolean default: true - - *615 + - *617 responses: '200': description: Response @@ -92557,7 +92753,7 @@ paths: application/json: schema: type: array - items: *324 + items: *326 examples: default: value: @@ -92604,8 +92800,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 requestBody: description: Request body required: true @@ -92625,16 +92821,16 @@ paths: - tag - push default: branch - enforcement: *300 + enforcement: *302 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *298 + items: *303 + conditions: *300 rules: type: array description: An array of rules within the ruleset. - items: *616 + items: *618 required: - name - enforcement @@ -92665,9 +92861,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: &626 + default: &628 value: id: 42 name: super cool ruleset @@ -92715,12 +92911,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *342 - - *343 - - *617 - - *618 + - *344 + - *345 - *619 - *620 + - *621 + - *622 - *17 - *19 responses: @@ -92728,9 +92924,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *623 examples: - default: *622 + default: *624 '404': *6 '500': *55 x-github: @@ -92751,17 +92947,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *342 - - *343 - - *623 + - *344 + - *345 + - *625 responses: '200': description: Response content: application/json: - schema: *624 + schema: *626 examples: - default: *625 + default: *627 '404': *6 '500': *55 x-github: @@ -92789,8 +92985,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92810,9 +93006,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: *626 + default: *628 '404': *6 '500': *55 put: @@ -92830,8 +93026,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92856,16 +93052,16 @@ paths: - branch - tag - push - enforcement: *300 + enforcement: *302 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *298 + items: *303 + conditions: *300 rules: description: An array of rules within the ruleset. type: array - items: *616 + items: *618 examples: default: value: @@ -92893,9 +93089,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: *626 + default: *628 '404': *6 '422': *15 '500': *55 @@ -92914,8 +93110,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92938,8 +93134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 - name: ruleset_id @@ -92955,9 +93151,9 @@ paths: application/json: schema: type: array - items: *327 + items: *329 examples: - default: *627 + default: *629 '404': *6 '500': *55 x-github: @@ -92976,8 +93172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *342 - - *343 + - *344 + - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92995,7 +93191,7 @@ paths: description: Response content: application/json: - schema: *628 + schema: *630 examples: default: value: @@ -93050,25 +93246,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *342 - - *343 - - *629 - - *630 + - *344 + - *345 - *631 - *632 - *633 - *634 - *635 - *636 + - *637 + - *638 - *62 - *19 - *17 - - *637 - - *638 - *639 - *640 - *641 - *642 + - *643 + - *644 responses: '200': description: Response @@ -93076,11 +93272,11 @@ paths: application/json: schema: type: array - items: &646 + items: &648 type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -93088,15 +93284,15 @@ paths: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *643 - resolution: *644 + state: *645 + resolution: *646 resolved_at: type: string format: date-time @@ -93202,7 +93398,7 @@ paths: pull request. ' - oneOf: *645 + oneOf: *647 nullable: true has_more_locations: type: boolean @@ -93344,7 +93540,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93366,16 +93562,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *342 - - *343 - - *440 - - *642 + - *344 + - *345 + - *442 + - *644 responses: '200': description: Response content: application/json: - schema: *646 + schema: *648 examples: default: value: @@ -93406,7 +93602,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93429,9 +93625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 requestBody: required: true content: @@ -93439,8 +93635,8 @@ paths: schema: type: object properties: - state: *643 - resolution: *644 + state: *645 + resolution: *646 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -93451,6 +93647,14 @@ paths: to `null` to unassign the alert. type: string nullable: true + validity: + type: string + nullable: true + enum: + - active + - inactive + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -93476,7 +93680,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *648 examples: default: value: @@ -93548,8 +93752,9 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository - '503': *120 + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -93571,9 +93776,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 - *19 - *17 responses: @@ -93584,7 +93789,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &803 + items: &805 type: object properties: type: @@ -93610,8 +93815,6 @@ paths: example: commit details: oneOf: - - *647 - - *648 - *649 - *650 - *651 @@ -93623,6 +93826,8 @@ paths: - *657 - *658 - *659 + - *660 + - *661 examples: default: value: @@ -93682,11 +93887,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *68 + Link: *70 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93708,8 +93913,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -93717,14 +93922,14 @@ paths: schema: type: object properties: - reason: &661 + reason: &663 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *660 + placeholder_id: *662 required: - reason - placeholder_id @@ -93741,7 +93946,7 @@ paths: schema: type: object properties: - reason: *661 + reason: *663 expire_at: type: string format: date-time @@ -93764,7 +93969,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -93787,13 +93992,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *120 + '503': *122 '200': description: Response content: @@ -93803,7 +94008,7 @@ paths: properties: incremental_scans: type: array - items: &662 + items: &664 description: Information on a single scan performed by secret scanning on the repository type: object @@ -93829,15 +94034,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *662 + items: *664 backfill_scans: type: array - items: *662 + items: *664 custom_pattern_backfill_scans: type: array items: allOf: - - *662 + - *664 - type: object properties: pattern_name: @@ -93850,7 +94055,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *662 + items: *664 examples: default: value: @@ -93915,8 +94120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *342 - - *343 + - *344 + - *345 - *62 - name: sort description: The property to sort the results by. @@ -93960,9 +94165,9 @@ paths: application/json: schema: type: array - items: *663 + items: *665 examples: - default: *664 + default: *666 '400': *14 '404': *6 x-github: @@ -93985,8 +94190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -94059,7 +94264,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *332 required: - login - type @@ -94146,9 +94351,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *665 examples: - default: &666 + default: &668 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -94381,8 +94586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -94486,7 +94691,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *665 examples: default: value: @@ -94633,17 +94838,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *342 - - *343 - - *665 + - *344 + - *345 + - *667 responses: '200': description: Response content: application/json: - schema: *663 + schema: *665 examples: - default: *666 + default: *668 '403': *29 '404': *6 x-github: @@ -94667,9 +94872,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *342 - - *343 - - *665 + - *344 + - *345 + - *667 requestBody: required: true content: @@ -94742,7 +94947,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *332 required: - login - type @@ -94828,17 +95033,17 @@ paths: description: Response content: application/json: - schema: *663 + schema: *665 examples: - default: *666 - add_credit: *666 + default: *668 + add_credit: *668 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *128 + schema: *130 examples: invalid_state_transition: value: @@ -94869,9 +95074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *342 - - *343 - - *665 + - *344 + - *345 + - *667 responses: '202': *39 '400': *14 @@ -94898,17 +95103,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *342 - - *343 - - *665 + - *344 + - *345 + - *667 responses: '202': description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 + default: *349 '400': *14 '422': *15 '403': *29 @@ -94934,8 +95139,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -95012,7 +95217,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -95034,8 +95239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -95044,7 +95249,7 @@ paths: application/json: schema: type: array - items: &667 + items: &669 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -95077,8 +95282,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -95154,8 +95359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -95251,8 +95456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -95406,8 +95611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -95417,7 +95622,7 @@ paths: application/json: schema: type: array - items: *667 + items: *669 examples: default: value: @@ -95450,8 +95655,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *342 - - *343 + - *344 + - *345 - name: sha in: path required: true @@ -95505,7 +95710,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *670 examples: default: value: @@ -95559,8 +95764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -95572,9 +95777,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95592,14 +95797,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &669 + schema: &671 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -95667,8 +95872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -95694,7 +95899,7 @@ paths: description: Response content: application/json: - schema: *669 + schema: *671 examples: default: value: @@ -95721,8 +95926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -95742,8 +95947,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -95799,7 +96004,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95822,8 +96027,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *342 - - *343 + - *344 + - *345 - name: ref in: path required: true @@ -95859,8 +96064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -95870,11 +96075,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -95892,8 +96097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *342 - - *343 + - *344 + - *345 - *19 - *17 responses: @@ -95901,7 +96106,7 @@ paths: description: Response content: application/json: - schema: &670 + schema: &672 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -95913,7 +96118,7 @@ paths: required: - names examples: - default: &671 + default: &673 value: names: - octocat @@ -95936,8 +96141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -95968,9 +96173,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *672 examples: - default: *671 + default: *673 '404': *6 '422': *7 x-github: @@ -95991,9 +96196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *342 - - *343 - - &672 + - *344 + - *345 + - &674 name: per description: The time frame to display results for. in: query @@ -96022,7 +96227,7 @@ paths: example: 128 clones: type: array - items: &673 + items: &675 title: Traffic type: object properties: @@ -96109,8 +96314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -96200,8 +96405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -96261,9 +96466,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *342 - - *343 - - *672 + - *344 + - *345 + - *674 responses: '200': description: Response @@ -96282,7 +96487,7 @@ paths: example: 3782 views: type: array - items: *673 + items: *675 required: - uniques - count @@ -96359,8 +96564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -96396,7 +96601,7 @@ paths: description: Response content: application/json: - schema: *159 + schema: *161 examples: default: value: @@ -96634,8 +96839,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -96658,8 +96863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -96681,8 +96886,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -96708,8 +96913,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *342 - - *343 + - *344 + - *345 - name: ref in: path required: true @@ -96801,9 +97006,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 + default: *349 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -96844,7 +97049,7 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: default: value: @@ -97036,7 +97241,7 @@ paths: html_url: type: string format: uri - repository: *159 + repository: *161 score: type: number file_size: @@ -97054,7 +97259,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &674 + text_matches: &676 title: Search Result Text Matches type: array items: @@ -97168,7 +97373,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *120 + '503': *122 '422': *15 '403': *29 x-github: @@ -97216,7 +97421,7 @@ paths: enum: - author-date - committer-date - - &675 + - &677 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -97287,7 +97492,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *409 nullable: true comment_count: type: integer @@ -97307,7 +97512,7 @@ paths: url: type: string format: uri - verification: *531 + verification: *533 required: - author - committer @@ -97326,7 +97531,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *409 nullable: true parents: type: array @@ -97339,12 +97544,12 @@ paths: type: string sha: type: string - repository: *159 + repository: *161 score: type: number node_id: type: string - text_matches: *674 + text_matches: *676 required: - sha - node_id @@ -97536,7 +97741,7 @@ paths: - interactions - created - updated - - *675 + - *677 - *17 - *19 - name: advanced_search @@ -97650,11 +97855,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: type: string state_reason: @@ -97671,8 +97876,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *281 + required: *282 nullable: true comments: type: integer @@ -97686,7 +97891,7 @@ paths: type: string format: date-time nullable: true - text_matches: *674 + text_matches: *676 pull_request: type: object properties: @@ -97719,10 +97924,10 @@ paths: type: string score: type: number - author_association: *83 + author_association: *85 draft: type: boolean - repository: *80 + repository: *82 body_html: type: string body_text: @@ -97730,7 +97935,7 @@ paths: timeline_url: type: string format: uri - type: *242 + type: *244 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -97740,17 +97945,17 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 pinned_comment: title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - reactions: *84 + reactions: *86 required: - assignee - closed_at @@ -97904,7 +98109,7 @@ paths: - quoted_text items: - "..." - '503': *120 + '503': *122 '422': *15 '304': *37 '403': *29 @@ -97958,7 +98163,7 @@ paths: enum: - created - updated - - *675 + - *677 - *17 - *19 responses: @@ -98002,7 +98207,7 @@ paths: nullable: true score: type: number - text_matches: *674 + text_matches: *676 required: - id - node_id @@ -98087,7 +98292,7 @@ paths: - forks - help-wanted-issues - updated - - *675 + - *677 - *17 - *19 responses: @@ -98315,8 +98520,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true permissions: type: object @@ -98335,7 +98540,7 @@ paths: - admin - pull - push - text_matches: *674 + text_matches: *676 temp_clone_token: type: string allow_merge_commit: @@ -98537,7 +98742,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *120 + '503': *122 '422': *15 '304': *37 x-github: @@ -98635,7 +98840,7 @@ paths: type: string format: uri nullable: true - text_matches: *674 + text_matches: *676 related: type: array nullable: true @@ -98826,7 +99031,7 @@ paths: - followers - repositories - joined - - *675 + - *677 - *17 - *19 responses: @@ -98930,7 +99135,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *674 + text_matches: *676 blog: type: string nullable: true @@ -98989,7 +99194,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *120 + '503': *122 '422': *15 x-github: githubCloudOnly: false @@ -99009,7 +99214,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &678 + - &680 name: team_id description: The unique identifier of the team. in: path @@ -99021,9 +99226,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '404': *6 x-github: githubCloudOnly: false @@ -99050,7 +99255,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *678 + - *680 requestBody: required: true content: @@ -99113,16 +99318,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '201': description: Response content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '404': *6 '422': *15 '403': *29 @@ -99150,7 +99355,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *678 + - *680 responses: '204': description: Response @@ -99179,7 +99384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *678 + - *680 - *17 - *19 responses: @@ -99189,11 +99394,11 @@ paths: application/json: schema: type: array - items: *236 + items: *238 examples: - default: *237 + default: *239 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99217,7 +99422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *678 + - *680 - name: role description: Filters members returned by their role in the team. in: query @@ -99240,9 +99445,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -99268,8 +99473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '204': description: if user is a member @@ -99305,8 +99510,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '204': description: Response @@ -99345,8 +99550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '204': description: Response @@ -99382,16 +99587,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '200': description: Response content: application/json: - schema: *341 + schema: *343 examples: - response-if-user-is-a-team-maintainer: *679 + response-if-user-is-a-team-maintainer: *681 '404': *6 x-github: githubCloudOnly: false @@ -99424,8 +99629,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *678 - - *72 + - *680 + - *74 requestBody: required: false content: @@ -99450,9 +99655,9 @@ paths: description: Response content: application/json: - schema: *341 + schema: *343 examples: - response-if-users-membership-with-team-is-now-pending: *680 + response-if-users-membership-with-team-is-now-pending: *682 '403': description: Forbidden if team synchronization is set up '422': @@ -99486,8 +99691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '204': description: Response @@ -99514,7 +99719,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *678 + - *680 - *17 - *19 responses: @@ -99524,11 +99729,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -99556,15 +99761,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *678 - - *342 - - *343 + - *680 + - *344 + - *345 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *681 + schema: *683 examples: alternative-response-with-extra-repository-information: value: @@ -99715,9 +99920,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *678 - - *342 - - *343 + - *680 + - *344 + - *345 requestBody: required: false content: @@ -99767,9 +99972,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *678 - - *342 - - *343 + - *680 + - *344 + - *345 responses: '204': description: Response @@ -99794,7 +99999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *678 + - *680 - *17 - *19 responses: @@ -99804,11 +100009,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - response-if-child-teams-exist: *682 + response-if-child-teams-exist: *684 headers: - Link: *68 + Link: *70 '404': *6 '403': *29 '422': *15 @@ -99839,7 +100044,7 @@ paths: application/json: schema: oneOf: - - &684 + - &686 title: Private User description: Private User type: object @@ -100042,7 +100247,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *683 + - *685 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -100195,7 +100400,7 @@ paths: description: Response content: application/json: - schema: *684 + schema: *686 examples: default: value: @@ -100274,7 +100479,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '304': *37 '404': *6 '403': *29 @@ -100297,7 +100502,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *72 + - *74 responses: '204': description: If the user is blocked @@ -100325,7 +100530,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -100349,7 +100554,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -100398,9 +100603,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *249 examples: - default: *248 + default: *250 '304': *37 '500': *55 '401': *25 @@ -100539,21 +100744,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100593,7 +100798,7 @@ paths: type: integer secrets: type: array - items: &685 + items: &687 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -100633,9 +100838,9 @@ paths: - visibility - selected_repositories_url examples: - default: *466 + default: *468 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100703,13 +100908,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 responses: '200': description: Response content: application/json: - schema: *685 + schema: *687 examples: default: value: @@ -100739,7 +100944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 requestBody: required: true content: @@ -100784,7 +100989,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -100812,7 +101017,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 responses: '204': description: Response @@ -100837,7 +101042,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *167 + - *169 responses: '200': description: Response @@ -100853,9 +101058,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *196 + default: *198 '401': *25 '403': *29 '404': *6 @@ -100880,7 +101085,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *167 + - *169 requestBody: required: true content: @@ -100934,7 +101139,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *167 + - *169 - name: repository_id in: path required: true @@ -100967,7 +101172,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *167 + - *169 - name: repository_id in: path required: true @@ -100999,15 +101204,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '200': description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '304': *37 '500': *55 '401': *25 @@ -101033,7 +101238,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 requestBody: required: false content: @@ -101063,9 +101268,9 @@ paths: description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '401': *25 '403': *29 '404': *6 @@ -101087,7 +101292,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '202': *39 '304': *37 @@ -101116,13 +101321,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '202': description: Response content: application/json: - schema: &686 + schema: &688 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -101163,7 +101368,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &687 + default: &689 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -101195,7 +101400,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *249 + - *251 - name: export_id in: path required: true @@ -101208,9 +101413,9 @@ paths: description: Response content: application/json: - schema: *686 + schema: *688 examples: - default: *687 + default: *689 '404': *6 x-github: githubCloudOnly: false @@ -101231,7 +101436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *249 + - *251 responses: '200': description: Response @@ -101247,9 +101452,9 @@ paths: type: integer machines: type: array - items: *688 + items: *690 examples: - default: *689 + default: *691 '304': *37 '500': *55 '401': *25 @@ -101278,7 +101483,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *249 + - *251 requestBody: required: true content: @@ -101328,13 +101533,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *345 + repository: *347 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *464 - required: *465 + properties: *466 + required: *467 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -102108,15 +102313,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '200': description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '304': *37 '500': *55 '400': *14 @@ -102148,15 +102353,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '200': description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '500': *55 '401': *25 '403': *29 @@ -102186,9 +102391,9 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: &700 + default: &702 value: - id: 197 name: hello_docker @@ -102289,7 +102494,7 @@ paths: application/json: schema: type: array - items: &690 + items: &692 title: Email description: Email type: object @@ -102354,16 +102559,16 @@ paths: application/json: schema: type: array - items: *690 + items: *692 examples: - default: &702 + default: &704 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -102431,7 +102636,7 @@ paths: application/json: schema: type: array - items: *690 + items: *692 examples: default: value: @@ -102541,9 +102746,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -102574,9 +102779,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -102596,7 +102801,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *72 + - *74 responses: '204': description: if the person is followed by the authenticated user @@ -102626,7 +102831,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -102651,7 +102856,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -102687,7 +102892,7 @@ paths: application/json: schema: type: array - items: &691 + items: &693 title: GPG Key description: A unique encryption key type: object @@ -102818,7 +103023,7 @@ paths: - subkeys - revoked examples: - default: &718 + default: &720 value: - id: 3 name: Octocat's GPG Key @@ -102850,7 +103055,7 @@ paths: revoked: false raw_key: string headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -102903,9 +103108,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: &692 + default: &694 value: id: 3 name: Octocat's GPG Key @@ -102962,7 +103167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &693 + - &695 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102974,9 +103179,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *692 + default: *694 '404': *6 '304': *37 '403': *29 @@ -102999,7 +103204,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *693 + - *695 responses: '204': description: Response @@ -103142,7 +103347,7 @@ paths: suspended_at: suspended_by: headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -103190,11 +103395,11 @@ paths: type: array items: allOf: - - *80 + - *82 examples: - default: *151 + default: *153 headers: - Link: *68 + Link: *70 '404': *6 '403': *29 '304': *37 @@ -103218,7 +103423,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *148 + - *150 responses: '204': description: Response @@ -103244,7 +103449,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *148 + - *150 responses: '204': description: Response @@ -103278,12 +103483,12 @@ paths: application/json: schema: anyOf: - - *234 + - *236 - type: object properties: {} additionalProperties: false examples: - default: *235 + default: *237 '204': description: Response when there are no restrictions x-github: @@ -103307,7 +103512,7 @@ paths: required: true content: application/json: - schema: *542 + schema: *544 examples: default: value: @@ -103318,7 +103523,7 @@ paths: description: Response content: application/json: - schema: *234 + schema: *236 examples: default: value: @@ -103399,7 +103604,7 @@ paths: - closed - all default: open - - *245 + - *247 - name: sort description: What to sort results by. in: query @@ -103412,7 +103617,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -103422,11 +103627,11 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *246 + default: *248 headers: - Link: *68 + Link: *70 '404': *6 '304': *37 x-github: @@ -103457,7 +103662,7 @@ paths: application/json: schema: type: array - items: &694 + items: &696 title: Key description: Key type: object @@ -103508,7 +103713,7 @@ paths: verified: false read_only: false headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -103558,9 +103763,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *696 examples: - default: &695 + default: &697 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103593,15 +103798,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *577 + - *579 responses: '200': description: Response content: application/json: - schema: *694 + schema: *696 examples: - default: *695 + default: *697 '404': *6 '304': *37 '403': *29 @@ -103624,7 +103829,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *577 + - *579 responses: '204': description: Response @@ -103657,7 +103862,7 @@ paths: application/json: schema: type: array - items: &696 + items: &698 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103714,7 +103919,7 @@ paths: - id - type - login - plan: *104 + plan: *106 required: - billing_cycle - next_billing_date @@ -103725,7 +103930,7 @@ paths: - account - plan examples: - default: &697 + default: &699 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103758,7 +103963,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '304': *37 '401': *25 '404': *6 @@ -103787,11 +103992,11 @@ paths: application/json: schema: type: array - items: *696 + items: *698 examples: - default: *697 + default: *699 headers: - Link: *68 + Link: *70 '304': *37 '401': *25 x-github: @@ -103829,7 +104034,7 @@ paths: application/json: schema: type: array - items: *251 + items: *253 examples: default: value: @@ -103912,7 +104117,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -103937,13 +104142,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *251 + schema: *253 examples: default: value: @@ -104005,7 +104210,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *76 + - *78 requestBody: required: true content: @@ -104030,7 +104235,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *253 examples: default: value: @@ -104102,7 +104307,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: default: value: @@ -104255,7 +104460,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -104355,7 +104560,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *255 examples: default: value: @@ -104535,7 +104740,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *254 + - *256 - name: exclude in: query required: false @@ -104548,7 +104753,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *255 examples: default: value: @@ -104742,7 +104947,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *254 + - *256 responses: '302': description: Response @@ -104768,7 +104973,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *254 + - *256 responses: '204': description: Response @@ -104797,8 +105002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *254 - - *698 + - *256 + - *700 responses: '204': description: Response @@ -104822,7 +105027,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *254 + - *256 - *17 - *19 responses: @@ -104832,11 +105037,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -104869,11 +105074,11 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -104913,7 +105118,7 @@ paths: - docker - nuget - container - - *699 + - *701 - *19 - *17 responses: @@ -104923,10 +105128,10 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: *700 - '400': *701 + default: *702 + '400': *703 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104946,16 +105151,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 + - *265 responses: '200': description: Response content: application/json: - schema: *260 + schema: *262 examples: - default: &719 + default: &721 value: id: 40201 name: octo-name @@ -105068,8 +105273,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 + - *265 responses: '204': description: Response @@ -105099,8 +105304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 + - *265 - name: token description: package token schema: @@ -105132,8 +105337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *262 - - *263 + - *264 + - *265 - *19 - *17 - name: state @@ -105153,7 +105358,7 @@ paths: application/json: schema: type: array - items: *264 + items: *266 examples: default: value: @@ -105202,15 +105407,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 - *265 + - *267 responses: '200': description: Response content: application/json: - schema: *264 + schema: *266 examples: default: value: @@ -105246,9 +105451,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 - *265 + - *267 responses: '204': description: Response @@ -105278,9 +105483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 - *265 + - *267 responses: '204': description: Response @@ -105317,11 +105522,11 @@ paths: application/json: schema: type: array - items: *690 + items: *692 examples: - default: *702 + default: *704 headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -105430,9 +105635,9 @@ paths: application/json: schema: type: array - items: *80 + items: *82 examples: - default: &709 + default: &711 summary: Default response value: - id: 1296269 @@ -105553,7 +105758,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '403': *29 @@ -105736,9 +105941,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 + default: *349 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105776,11 +105981,11 @@ paths: application/json: schema: type: array - items: *544 + items: *546 examples: - default: *703 + default: *705 headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -105801,7 +106006,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *238 + - *240 responses: '204': description: Response @@ -105824,7 +106029,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *238 + - *240 responses: '204': description: Response @@ -105857,7 +106062,7 @@ paths: application/json: schema: type: array - items: &704 + items: &706 title: Social account description: Social media account type: object @@ -105872,12 +106077,12 @@ paths: - provider - url examples: - default: &705 + default: &707 value: - provider: twitter url: https://twitter.com/github headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -105934,9 +106139,9 @@ paths: application/json: schema: type: array - items: *704 + items: *706 examples: - default: *705 + default: *707 '422': *15 '304': *37 '404': *6 @@ -106023,7 +106228,7 @@ paths: application/json: schema: type: array - items: &706 + items: &708 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -106043,7 +106248,7 @@ paths: - title - created_at examples: - default: &737 + default: &739 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -106054,7 +106259,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -106107,9 +106312,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: &707 + default: &709 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -106139,7 +106344,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &708 + - &710 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -106151,9 +106356,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *707 + default: *709 '404': *6 '304': *37 '403': *29 @@ -106176,7 +106381,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *708 + - *710 responses: '204': description: Response @@ -106205,7 +106410,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &738 + - &740 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -106228,13 +106433,13 @@ paths: application/json: schema: type: array - items: *80 + items: *82 examples: - default-response: *709 + default-response: *711 application/vnd.github.v3.star+json: schema: type: array - items: &739 + items: &741 title: Starred Repository description: Starred Repository type: object @@ -106242,7 +106447,7 @@ paths: starred_at: type: string format: date-time - repo: *80 + repo: *82 required: - starred_at - repo @@ -106370,7 +106575,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -106390,8 +106595,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response if this repository is starred by you @@ -106419,8 +106624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -106444,8 +106649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -106478,11 +106683,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -106517,7 +106722,7 @@ paths: application/json: schema: type: array - items: *338 + items: *340 examples: default: value: @@ -106568,7 +106773,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -106595,7 +106800,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *106 + - *108 responses: '200': description: Response @@ -106603,10 +106808,10 @@ paths: application/json: schema: oneOf: - - *684 - - *683 + - *686 + - *685 examples: - default-response: &713 + default-response: &715 summary: Default response value: login: octocat @@ -106641,7 +106846,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &714 + response-with-git-hub-plan-information: &716 summary: Response with GitHub plan information value: login: octocat @@ -106698,14 +106903,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &711 + - &713 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *278 + - *280 requestBody: required: true description: Details of the draft item to create in the project. @@ -106739,9 +106944,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *286 examples: - draft_issue: *285 + draft_issue: *287 '304': *37 '403': *29 '401': *25 @@ -106764,7 +106969,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *710 + - *712 - *17 responses: '200': @@ -106775,7 +106980,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: Link: example: ; rel="next" @@ -106799,8 +107004,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *711 - - *278 + - *713 + - *280 requestBody: required: true content: @@ -106871,17 +107076,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *712 + schema: *714 examples: table_view: summary: Response for creating a table view - value: *289 + value: *291 board_view: summary: Response for creating a board view with filter - value: *289 + value: *291 roadmap_view: summary: Response for creating a roadmap view - value: *289 + value: *291 '304': *37 '403': *29 '401': *25 @@ -106915,7 +107120,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *72 + - *74 responses: '200': description: Response @@ -106923,11 +107128,11 @@ paths: application/json: schema: oneOf: - - *684 - - *683 + - *686 + - *685 examples: - default-response: *713 - response-with-git-hub-plan-information: *714 + default-response: *715 + response-with-git-hub-plan-information: *716 '404': *6 x-github: githubCloudOnly: false @@ -106953,7 +107158,7 @@ paths: - *17 - *47 - *48 - - *72 + - *74 requestBody: required: true content: @@ -106977,8 +107182,8 @@ paths: required: - subject_digests examples: - default: *715 - withPredicateType: *716 + default: *717 + withPredicateType: *718 responses: '200': description: Response @@ -107031,7 +107236,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *717 + default: *719 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107049,7 +107254,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *72 + - *74 requestBody: required: true content: @@ -107114,7 +107319,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *72 + - *74 - name: subject_digest description: Subject Digest in: path @@ -107145,7 +107350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *72 + - *74 - name: attestation_id description: Attestation ID in: path @@ -107183,7 +107388,7 @@ paths: - *17 - *47 - *48 - - *72 + - *74 - name: subject_digest description: Subject Digest in: path @@ -107236,12 +107441,12 @@ paths: initiator: type: string examples: - default: *403 + default: *405 '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -107267,7 +107472,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *72 + - *74 responses: '200': description: Response @@ -107275,9 +107480,9 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: *700 + default: *702 '403': *29 '401': *25 x-github: @@ -107300,7 +107505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107310,7 +107515,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -107372,8 +107577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *72 - - *76 + - *74 + - *78 - *17 - *19 responses: @@ -107383,7 +107588,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -107460,7 +107665,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107470,7 +107675,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -107528,7 +107733,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107540,9 +107745,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107559,7 +107764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107571,9 +107776,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107590,7 +107795,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *72 + - *74 - name: target_user in: path required: true @@ -107617,8 +107822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *72 - - *93 + - *74 + - *95 - *17 - *19 responses: @@ -107628,11 +107833,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -107651,7 +107856,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107661,11 +107866,11 @@ paths: application/json: schema: type: array - items: *691 + items: *693 examples: - default: *718 + default: *720 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107687,7 +107892,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *72 + - *74 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -107759,7 +107964,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *72 + - *74 responses: '200': description: Response @@ -107767,7 +107972,7 @@ paths: application/json: schema: *22 examples: - default: *541 + default: *543 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107785,7 +107990,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107820,7 +108025,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107840,7 +108045,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107850,11 +108055,11 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107891,8 +108096,8 @@ paths: - docker - nuget - container - - *699 - - *72 + - *701 + - *74 - *19 - *17 responses: @@ -107902,12 +108107,12 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: *700 + default: *702 '403': *29 '401': *25 - '400': *701 + '400': *703 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107927,17 +108132,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 + - *265 + - *74 responses: '200': description: Response content: application/json: - schema: *260 + schema: *262 examples: - default: *719 + default: *721 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107958,9 +108163,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 + - *265 + - *74 responses: '204': description: Response @@ -107992,9 +108197,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 + - *265 + - *74 - name: token description: package token schema: @@ -108026,9 +108231,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *262 - - *263 - - *72 + - *264 + - *265 + - *74 responses: '200': description: Response @@ -108036,7 +108241,7 @@ paths: application/json: schema: type: array - items: *264 + items: *266 examples: default: value: @@ -108094,16 +108299,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *262 - - *263 + - *264 - *265 - - *72 + - *267 + - *74 responses: '200': description: Response content: application/json: - schema: *264 + schema: *266 examples: default: value: @@ -108138,10 +108343,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 - *265 + - *74 + - *267 responses: '204': description: Response @@ -108173,10 +108378,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 - *265 + - *74 + - *267 responses: '204': description: Response @@ -108200,7 +108405,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *72 + - *74 - name: q description: Limit results to projects of the specified type. in: query @@ -108217,11 +108422,11 @@ paths: application/json: schema: type: array - items: *276 + items: *278 examples: - default: *277 + default: *279 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108241,18 +108446,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *278 - - *72 + - *280 + - *74 responses: '200': description: Response content: application/json: - schema: *276 + schema: *278 examples: - default: *277 + default: *279 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108272,8 +108477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *278 - - *72 + - *280 + - *74 - *17 - *47 - *48 @@ -108284,11 +108489,11 @@ paths: application/json: schema: type: array - items: *282 + items: *284 examples: - default: *720 + default: *722 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108307,8 +108512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - - *72 - - *278 + - *74 + - *280 requestBody: required: true content: @@ -108346,7 +108551,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *721 + items: *723 required: - name - data_type @@ -108362,7 +108567,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *722 + iteration_configuration: *724 required: - name - data_type @@ -108384,20 +108589,20 @@ paths: value: name: Due date data_type: date - single_select_field: *723 - iteration_field: *724 + single_select_field: *725 + iteration_field: *726 responses: '201': description: Response content: application/json: - schema: *282 + schema: *284 examples: - text_field: *725 - number_field: *726 - date_field: *727 - single_select_field: *728 - iteration_field: *729 + text_field: *727 + number_field: *728 + date_field: *729 + single_select_field: *730 + iteration_field: *731 '304': *37 '403': *29 '401': *25 @@ -108418,19 +108623,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *278 - - *730 - - *72 + - *280 + - *732 + - *74 responses: '200': description: Response content: application/json: - schema: *282 + schema: *284 examples: - default: *731 + default: *733 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108451,8 +108656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *278 - - *72 + - *280 + - *74 - *47 - *48 - *17 @@ -108484,11 +108689,11 @@ paths: application/json: schema: type: array - items: *286 + items: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108507,8 +108712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *72 - - *278 + - *74 + - *280 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -108578,22 +108783,22 @@ paths: description: Response content: application/json: - schema: *284 + schema: *286 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *285 + value: *287 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *285 + value: *287 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *285 + value: *287 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *285 + value: *287 '304': *37 '403': *29 '401': *25 @@ -108613,9 +108818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *278 - - *72 - - *288 + - *280 + - *74 + - *290 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -108635,11 +108840,11 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108658,9 +108863,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *278 - - *72 - - *288 + - *280 + - *74 + - *290 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -108730,13 +108935,13 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - text_field: *287 - number_field: *287 - date_field: *287 - single_select_field: *287 - iteration_field: *287 + text_field: *289 + number_field: *289 + date_field: *289 + single_select_field: *289 + iteration_field: *289 '401': *25 '403': *29 '404': *6 @@ -108756,9 +108961,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *278 - - *72 - - *288 + - *280 + - *74 + - *290 responses: '204': description: Response @@ -108780,9 +108985,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *278 - - *72 - - *732 + - *280 + - *74 + - *734 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -108808,11 +109013,11 @@ paths: application/json: schema: type: array - items: *286 + items: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108838,7 +109043,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108848,7 +109053,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -108913,7 +109118,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108923,7 +109128,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -108986,7 +109191,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *72 + - *74 - name: type description: Limit results to repositories of the specified type. in: query @@ -109029,11 +109234,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109053,12 +109258,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - - *72 - - *122 + - *74 - *124 - - *123 - - *733 + - *126 - *125 + - *735 + - *127 responses: '200': description: Response when getting a billing premium request usage report @@ -109166,7 +109371,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109186,10 +109391,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - - *72 - - *122 - - *734 - - *123 + - *74 + - *124 + - *736 + - *125 responses: '200': description: Response when getting a billing usage report @@ -109260,7 +109465,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109283,13 +109488,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - - *72 - - *122 + - *74 - *124 - - *123 - - *735 + - *126 - *125 - - *736 + - *737 + - *127 + - *738 responses: '200': description: Response when getting a billing usage summary @@ -109395,7 +109600,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109413,7 +109618,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -109423,11 +109628,11 @@ paths: application/json: schema: type: array - items: *704 + items: *706 examples: - default: *705 + default: *707 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109445,7 +109650,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -109455,11 +109660,11 @@ paths: application/json: schema: type: array - items: *706 + items: *708 examples: - default: *737 + default: *739 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109481,8 +109686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *72 - - *738 + - *74 + - *740 - *62 - *17 - *19 @@ -109494,13 +109699,13 @@ paths: schema: anyOf: - type: array - items: *739 + items: *741 - type: array - items: *80 + items: *82 examples: - default-response: *709 + default-response: *711 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109517,7 +109722,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -109527,11 +109732,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *266 + default: *268 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109657,7 +109862,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &740 + enterprise: &742 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -109715,7 +109920,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &741 + installation: &743 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -109734,7 +109939,7 @@ x-webhooks: required: - id - node_id - organization: &742 + organization: &744 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -109794,13 +109999,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &743 + repository: &745 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &775 + properties: &777 id: description: Unique identifier of the repository example: 42 @@ -109820,8 +110025,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true organization: title: Simple User @@ -110495,7 +110700,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &776 + required: &778 - archive_url - assignees_url - blobs_url @@ -110646,10 +110851,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -110725,11 +110930,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - rule: &744 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + rule: &746 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -110952,11 +111157,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - rule: *744 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + rule: *746 sender: *4 required: - action @@ -111139,11 +111344,11 @@ x-webhooks: - everyone required: - from - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - rule: *744 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + rule: *746 sender: *4 required: - action @@ -111227,7 +111432,7 @@ x-webhooks: type: string enum: - completed - check_run: &746 + check_run: &748 title: CheckRun description: A check performed on the code of a given code change type: object @@ -111280,8 +111485,8 @@ x-webhooks: type: string pull_requests: type: array - items: *91 - repository: *159 + items: *93 + repository: *161 status: example: completed type: string @@ -111318,7 +111523,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *745 + deployment: *747 details_url: example: https://example.com type: string @@ -111368,7 +111573,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *91 + items: *93 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -111403,10 +111608,10 @@ x-webhooks: - output - app - pull_requests - installation: *741 - enterprise: *740 - organization: *742 - repository: *743 + installation: *743 + enterprise: *742 + organization: *744 + repository: *745 sender: *4 required: - check_run @@ -111797,11 +112002,11 @@ x-webhooks: type: string enum: - created - check_run: *746 - installation: *741 - enterprise: *740 - organization: *742 - repository: *743 + check_run: *748 + installation: *743 + enterprise: *742 + organization: *744 + repository: *745 sender: *4 required: - check_run @@ -112195,11 +112400,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *746 - installation: *741 - enterprise: *740 - organization: *742 - repository: *743 + check_run: *748 + installation: *743 + enterprise: *742 + organization: *744 + repository: *745 requested_action: description: The action requested by the user. type: object @@ -112602,11 +112807,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *746 - installation: *741 - enterprise: *740 - organization: *742 - repository: *743 + check_run: *748 + installation: *743 + enterprise: *742 + organization: *744 + repository: *745 sender: *4 required: - check_run @@ -113576,10 +113781,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -114268,10 +114473,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -114954,10 +115159,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -115123,7 +115328,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -115268,20 +115473,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &747 + commit_oid: &749 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *740 - installation: *741 - organization: *742 - ref: &748 + enterprise: *742 + installation: *743 + organization: *744 + ref: &750 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *743 + repository: *745 sender: *4 required: - action @@ -115446,7 +115651,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -115676,12 +115881,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *747 - enterprise: *740 - installation: *741 - organization: *742 - ref: *748 - repository: *743 + commit_oid: *749 + enterprise: *742 + installation: *743 + organization: *744 + ref: *750 + repository: *745 sender: *4 required: - action @@ -115776,7 +115981,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115947,12 +116152,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *747 - enterprise: *740 - installation: *741 - organization: *742 - ref: *748 - repository: *743 + commit_oid: *749 + enterprise: *742 + installation: *743 + organization: *744 + ref: *750 + repository: *745 sender: *4 required: - action @@ -116118,7 +116323,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116284,12 +116489,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *747 - enterprise: *740 - installation: *741 - organization: *742 - ref: *748 - repository: *743 + commit_oid: *749 + enterprise: *742 + installation: *743 + organization: *744 + ref: *750 + repository: *745 sender: *4 required: - action @@ -116388,7 +116593,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116563,16 +116768,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *743 + repository: *745 sender: *4 required: - action @@ -116669,7 +116874,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116809,12 +117014,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *747 - enterprise: *740 - installation: *741 - organization: *742 - ref: *748 - repository: *743 + commit_oid: *749 + enterprise: *742 + installation: *743 + organization: *744 + ref: *750 + repository: *745 sender: *4 required: - action @@ -116980,7 +117185,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -117125,10 +117330,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -117383,10 +117588,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -117466,18 +117671,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *742 - pusher_type: &749 + organization: *744 + pusher_type: &751 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &750 + ref: &752 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -117487,7 +117692,7 @@ x-webhooks: enum: - tag - branch - repository: *743 + repository: *745 sender: *4 required: - ref @@ -117569,10 +117774,10 @@ x-webhooks: type: string enum: - created - definition: *290 - enterprise: *740 - installation: *741 - organization: *742 + definition: *292 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -117657,9 +117862,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -117736,10 +117941,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *290 - enterprise: *740 - installation: *741 - organization: *742 + definition: *292 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -117816,10 +118021,10 @@ x-webhooks: type: string enum: - updated - definition: *290 - enterprise: *740 - installation: *741 - organization: *742 + definition: *292 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -117896,19 +118101,19 @@ x-webhooks: type: string enum: - updated - enterprise: *740 - installation: *741 - repository: *743 - organization: *742 + enterprise: *742 + installation: *743 + repository: *745 + organization: *744 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *294 + items: *296 old_property_values: type: array description: The old custom property values for the repository. - items: *294 + items: *296 required: - action - repository @@ -117984,18 +118189,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 - pusher_type: *749 - ref: *750 + enterprise: *742 + installation: *743 + organization: *744 + pusher_type: *751 + ref: *752 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *743 + repository: *745 sender: *4 required: - ref @@ -118075,11 +118280,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118159,11 +118364,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118244,11 +118449,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118329,11 +118534,11 @@ x-webhooks: type: string enum: - created - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118412,11 +118617,11 @@ x-webhooks: type: string enum: - dismissed - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118495,11 +118700,11 @@ x-webhooks: type: string enum: - fixed - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118579,11 +118784,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118662,11 +118867,11 @@ x-webhooks: type: string enum: - reopened - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118743,9 +118948,9 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - key: &751 + enterprise: *742 + installation: *743 + key: &753 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -118781,8 +118986,8 @@ x-webhooks: - verified - created_at - read_only - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -118859,11 +119064,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - key: *751 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + key: *753 + organization: *744 + repository: *745 sender: *4 required: - action @@ -119419,12 +119624,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: &757 + workflow: &759 title: Workflow type: object nullable: true @@ -120165,15 +120370,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *752 - required: *753 + properties: *754 + required: *755 nullable: true pull_requests: type: array - items: *596 - repository: *743 - organization: *742 - installation: *741 + items: *598 + repository: *745 + organization: *744 + installation: *743 sender: *4 responses: '200': @@ -120244,7 +120449,7 @@ x-webhooks: type: string enum: - approved - approver: &754 + approver: &756 type: object properties: avatar_url: @@ -120287,11 +120492,11 @@ x-webhooks: type: string comment: type: string - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - reviewers: &755 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + reviewers: &757 type: array items: type: object @@ -120370,7 +120575,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &756 + workflow_job_run: &758 type: object properties: conclusion: @@ -121101,18 +121306,18 @@ x-webhooks: type: string enum: - rejected - approver: *754 + approver: *756 comment: type: string - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - reviewers: *755 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + reviewers: *757 sender: *4 since: type: string - workflow_job_run: *756 + workflow_job_run: *758 workflow_job_runs: type: array items: @@ -121816,13 +122021,13 @@ x-webhooks: type: string enum: - requested - enterprise: *740 + enterprise: *742 environment: type: string - installation: *741 - organization: *742 - repository: *743 - requestor: &762 + installation: *743 + organization: *744 + repository: *745 + requestor: &764 title: User type: object nullable: true @@ -123711,12 +123916,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: *757 + workflow: *759 workflow_run: title: Deployment Workflow Run type: object @@ -124396,7 +124601,7 @@ x-webhooks: type: string enum: - answered - answer: &760 + answer: &762 type: object properties: author_association: @@ -124553,11 +124758,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124684,11 +124889,11 @@ x-webhooks: - from required: - category - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124771,11 +124976,11 @@ x-webhooks: type: string enum: - closed - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124857,7 +125062,7 @@ x-webhooks: type: string enum: - created - comment: &759 + comment: &761 type: object properties: author_association: @@ -125014,11 +125219,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125101,12 +125306,12 @@ x-webhooks: type: string enum: - deleted - comment: *759 - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + comment: *761 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125201,12 +125406,12 @@ x-webhooks: - from required: - body - comment: *759 - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + comment: *761 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125290,11 +125495,11 @@ x-webhooks: type: string enum: - created - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125376,11 +125581,11 @@ x-webhooks: type: string enum: - deleted - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125480,11 +125685,11 @@ x-webhooks: type: string required: - from - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125566,10 +125771,10 @@ x-webhooks: type: string enum: - labeled - discussion: *758 - enterprise: *740 - installation: *741 - label: &761 + discussion: *760 + enterprise: *742 + installation: *743 + label: &763 title: Label type: object properties: @@ -125601,8 +125806,8 @@ x-webhooks: - color - default - description - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125685,11 +125890,11 @@ x-webhooks: type: string enum: - locked - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125771,11 +125976,11 @@ x-webhooks: type: string enum: - pinned - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125857,11 +126062,11 @@ x-webhooks: type: string enum: - reopened - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125946,16 +126151,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *758 - new_repository: *743 + new_discussion: *760 + new_repository: *745 required: - new_discussion - new_repository - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -126038,10 +126243,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *758 - old_answer: *760 - organization: *742 - repository: *743 + discussion: *760 + old_answer: *762 + organization: *744 + repository: *745 sender: *4 required: - action @@ -126123,12 +126328,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *758 - enterprise: *740 - installation: *741 - label: *761 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -126211,11 +126416,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -126297,11 +126502,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -126374,7 +126579,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *740 + enterprise: *742 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -127034,9 +127239,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *741 - organization: *742 - repository: *743 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - forkee @@ -127182,9 +127387,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pages: description: The pages that were updated. type: array @@ -127221,7 +127426,7 @@ x-webhooks: - action - sha - html_url - repository: *743 + repository: *745 sender: *4 required: - pages @@ -127297,10 +127502,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: &763 + organization: *744 + repositories: &765 description: An array of repository objects that the installation can access. type: array @@ -127326,8 +127531,8 @@ x-webhooks: - name - full_name - private - repository: *743 - requester: *762 + repository: *745 + requester: *764 sender: *4 required: - action @@ -127402,11 +127607,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: *763 - repository: *743 + organization: *744 + repositories: *765 + repository: *745 requester: nullable: true sender: *4 @@ -127482,11 +127687,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: *763 - repository: *743 + organization: *744 + repositories: *765 + repository: *745 requester: nullable: true sender: *4 @@ -127562,10 +127767,10 @@ x-webhooks: type: string enum: - added - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories_added: &764 + organization: *744 + repositories_added: &766 description: An array of repository objects, which were added to the installation. type: array @@ -127611,15 +127816,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *743 - repository_selection: &765 + repository: *745 + repository_selection: &767 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *762 + requester: *764 sender: *4 required: - action @@ -127698,10 +127903,10 @@ x-webhooks: type: string enum: - removed - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories_added: *764 + organization: *744 + repositories_added: *766 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127728,9 +127933,9 @@ x-webhooks: - name - full_name - private - repository: *743 - repository_selection: *765 - requester: *762 + repository: *745 + repository_selection: *767 + requester: *764 sender: *4 required: - action @@ -127809,11 +128014,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: *763 - repository: *743 + organization: *744 + repositories: *765 + repository: *745 requester: nullable: true sender: *4 @@ -127991,10 +128196,10 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 target_type: type: string @@ -128073,11 +128278,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: *763 - repository: *743 + organization: *744 + repositories: *765 + repository: *745 requester: nullable: true sender: *4 @@ -128201,8 +128406,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 reactions: title: Reactions type: object @@ -128251,8 +128456,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *573 - required: *574 + properties: *575 + required: *576 nullable: true user: title: User @@ -128337,8 +128542,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129127,8 +129332,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129144,7 +129349,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -129477,8 +129682,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -129558,7 +129763,7 @@ x-webhooks: type: string enum: - deleted - comment: &766 + comment: &768 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129715,8 +129920,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *573 - required: *574 + properties: *575 + required: *576 nullable: true required: - url @@ -129731,8 +129936,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -130517,8 +130722,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130534,7 +130739,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -130869,8 +131074,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -130950,7 +131155,7 @@ x-webhooks: type: string enum: - edited - changes: &795 + changes: &797 description: The changes to the comment. type: object properties: @@ -130962,9 +131167,9 @@ x-webhooks: type: string required: - from - comment: *766 - enterprise: *740 - installation: *741 + comment: *768 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131752,8 +131957,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131769,7 +131974,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -132102,8 +132307,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -132184,9 +132389,9 @@ x-webhooks: type: string enum: - pinned - comment: *766 - enterprise: *740 - installation: *741 + comment: *768 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -132976,8 +133181,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132993,7 +133198,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -133328,8 +133533,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -133409,9 +133614,9 @@ x-webhooks: type: string enum: - unpinned - comment: *766 - enterprise: *740 - installation: *741 + comment: *768 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134201,8 +134406,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134218,7 +134423,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -134553,8 +134758,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134637,15 +134842,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 + blocked_issue: *88 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - blocking_issue_repo: *80 - installation: *741 - organization: *742 - repository: *743 + blocking_issue: *88 + blocking_issue_repo: *82 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134728,15 +134933,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 + blocked_issue: *88 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - blocking_issue_repo: *80 - installation: *741 - organization: *742 - repository: *743 + blocking_issue: *88 + blocking_issue_repo: *82 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134818,15 +135023,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 - blocked_issue_repo: *80 + blocked_issue: *88 + blocked_issue_repo: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - installation: *741 - organization: *742 - repository: *743 + blocking_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134909,15 +135114,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 - blocked_issue_repo: *80 + blocked_issue: *88 + blocked_issue_repo: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - installation: *741 - organization: *742 - repository: *743 + blocking_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134997,9 +135202,9 @@ x-webhooks: type: string enum: - assigned - assignee: *762 - enterprise: *740 - installation: *741 + assignee: *764 + enterprise: *742 + installation: *743 issue: &769 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135789,14 +135994,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135812,7 +136017,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -135913,8 +136118,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -135994,8 +136199,8 @@ x-webhooks: type: string enum: - closed - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -136789,14 +136994,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136812,7 +137017,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -137048,8 +137253,8 @@ x-webhooks: required: - state - closed_at - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -137128,8 +137333,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137914,14 +138119,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137937,7 +138142,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -138037,8 +138242,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -138117,8 +138322,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138925,14 +139130,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138948,7 +139153,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -139027,7 +139232,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &767 + milestone: &770 title: Milestone description: A collection of related issues and pull requests. type: object @@ -139165,8 +139370,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -139265,8 +139470,8 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140055,14 +140260,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140075,7 +140280,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *244 title: description: Title of the issue type: string @@ -140179,9 +140384,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *761 - organization: *742 - repository: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -140201,6 +140406,339 @@ x-webhooks: - repository - organization - app + issues-field-added: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue field value was set or updated on an issue. + operationId: issues/field-added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issues field_added event + type: object + properties: + action: + type: string + enum: + - field_added + enterprise: *742 + installation: *743 + issue: *769 + issue_field: + type: object + description: The issue field whose value was set or updated on the + issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was set or updated for the issue field. + When updating an existing value, the previous value is available + in `changes`. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present + for single_select field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + changes: + type: object + description: The previous field value, present when an existing + value was updated. + properties: + issue_field_value: + type: object + description: The previous issue field value data. + properties: + from: + type: object + description: The previous value of the issue field before + the update. + properties: + id: + type: integer + description: The unique identifier of the issue field + value. + value: + description: The previous value. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the previously selected + option. Present for single_select field types. + option: + type: object + description: The previously selected option details. + Present for single_select field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + required: + - from + organization: *744 + repository: *745 + sender: *4 + required: + - action + - issue + - issue_field + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-field-removed: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue field value was cleared from an issue. + operationId: issues/field-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issues field_removed event + type: object + properties: + action: + type: string + enum: + - field_removed + enterprise: *742 + installation: *743 + issue: *769 + issue_field: + type: object + description: The issue field whose value was cleared from the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was cleared from the issue field. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present + for single_select field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + organization: *744 + repository: *745 + sender: *4 + required: + - action + - issue + - issue_field + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app issues-labeled: post: summary: |- @@ -140261,8 +140799,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141050,14 +141588,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141070,7 +141608,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *244 title: description: Title of the issue type: string @@ -141174,9 +141712,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *761 - organization: *742 - repository: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -141256,8 +141794,8 @@ x-webhooks: type: string enum: - locked - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142069,14 +142607,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142089,7 +142627,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *244 title: description: Title of the issue type: string @@ -142170,8 +142708,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -142250,8 +142788,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143057,14 +143595,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143080,7 +143618,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -143158,9 +143696,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *767 - organization: *742 - repository: *743 + milestone: *770 + organization: *744 + repository: *745 sender: *4 required: - action @@ -144023,11 +144561,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144055,8 +144593,8 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true user: title: User @@ -144128,7 +144666,7 @@ x-webhooks: required: - login - id - type: *242 + type: *244 required: - id - number @@ -144608,8 +145146,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145393,11 +145931,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145413,7 +145951,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -145426,8 +145964,8 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true user: title: User @@ -145521,8 +146059,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -145602,9 +146140,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *740 - installation: *741 - issue: &768 + enterprise: *742 + installation: *743 + issue: &771 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -146387,14 +146925,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146410,7 +146948,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -146510,8 +147048,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -146590,8 +147128,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147401,14 +147939,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147502,9 +148040,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *242 - organization: *742 - repository: *743 + type: *244 + organization: *744 + repository: *745 sender: *4 required: - action @@ -148370,14 +148908,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148393,7 +148931,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -148972,11 +149510,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *740 - installation: *741 - issue: *768 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + issue: *771 + organization: *744 + repository: *745 sender: *4 required: - action @@ -149056,12 +149594,12 @@ x-webhooks: type: string enum: - typed - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: *769 - type: *242 - organization: *742 - repository: *743 + type: *244 + organization: *744 + repository: *745 sender: *4 required: - action @@ -149142,7 +149680,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &798 + assignee: &800 title: User type: object nullable: true @@ -149212,11 +149750,11 @@ x-webhooks: required: - login - id - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: *769 - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -149295,12 +149833,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: *769 - label: *761 - organization: *742 - repository: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -149380,8 +149918,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150191,14 +150729,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150214,7 +150752,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -150292,8 +150830,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150373,11 +150911,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *740 - installation: *741 - issue: *768 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + issue: *771 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150456,12 +150994,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: *769 - type: *242 - organization: *742 - repository: *743 + type: *244 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150541,11 +151079,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - label: *761 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150623,11 +151161,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - label: *761 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150737,11 +151275,11 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - label: *761 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150823,9 +151361,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *740 - installation: *741 - marketplace_purchase: &770 + enterprise: *742 + installation: *743 + marketplace_purchase: &772 title: Marketplace Purchase type: object required: @@ -150908,8 +151446,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *742 - previous_marketplace_purchase: &771 + organization: *744 + previous_marketplace_purchase: &773 title: Marketplace Purchase type: object properties: @@ -150989,7 +151527,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *743 + repository: *745 sender: *4 required: - action @@ -151069,10 +151607,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *740 - installation: *741 - marketplace_purchase: *770 - organization: *742 + enterprise: *742 + installation: *743 + marketplace_purchase: *772 + organization: *744 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -151155,7 +151693,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *743 + repository: *745 sender: *4 required: - action @@ -151237,10 +151775,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *740 - installation: *741 - marketplace_purchase: *770 - organization: *742 + enterprise: *742 + installation: *743 + marketplace_purchase: *772 + organization: *744 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -151322,7 +151860,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *743 + repository: *745 sender: *4 required: - action @@ -151403,8 +151941,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 marketplace_purchase: title: Marketplace Purchase type: object @@ -151486,9 +152024,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *742 - previous_marketplace_purchase: *771 - repository: *743 + organization: *744 + previous_marketplace_purchase: *773 + repository: *745 sender: *4 required: - action @@ -151568,12 +152106,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *740 - installation: *741 - marketplace_purchase: *770 - organization: *742 - previous_marketplace_purchase: *771 - repository: *743 + enterprise: *742 + installation: *743 + marketplace_purchase: *772 + organization: *744 + previous_marketplace_purchase: *773 + repository: *745 sender: *4 required: - action @@ -151675,11 +152213,11 @@ x-webhooks: type: string required: - to - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 sender: *4 required: - action @@ -151779,11 +152317,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 sender: *4 required: - action @@ -151862,11 +152400,11 @@ x-webhooks: type: string enum: - removed - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 sender: *4 required: - action @@ -151944,11 +152482,11 @@ x-webhooks: type: string enum: - added - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152024,7 +152562,7 @@ x-webhooks: required: - login - id - team: &772 + team: &774 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -152247,11 +152785,11 @@ x-webhooks: type: string enum: - removed - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152328,7 +152866,7 @@ x-webhooks: required: - login - id - team: *772 + team: *774 required: - action - scope @@ -152410,8 +152948,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *741 - merge_group: &774 + installation: *743 + merge_group: &776 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -152430,15 +152968,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *773 + head_commit: *775 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152524,10 +153062,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *741 - merge_group: *774 - organization: *742 - repository: *743 + installation: *743 + merge_group: *776 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152600,7 +153138,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 + enterprise: *742 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -152709,16 +153247,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *741 - organization: *742 + installation: *743 + organization: *744 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *775 - required: *776 + properties: *777 + required: *778 nullable: true sender: *4 required: @@ -152799,11 +153337,11 @@ x-webhooks: type: string enum: - closed - enterprise: *740 - installation: *741 - milestone: *767 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + milestone: *770 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152882,9 +153420,9 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - milestone: &777 + enterprise: *742 + installation: *743 + milestone: &779 title: Milestone description: A collection of related issues and pull requests. type: object @@ -153021,8 +153559,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153101,11 +153639,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - milestone: *767 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + milestone: *770 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153215,11 +153753,11 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - milestone: *767 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + milestone: *770 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153299,11 +153837,11 @@ x-webhooks: type: string enum: - opened - enterprise: *740 - installation: *741 - milestone: *777 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + milestone: *779 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153382,11 +153920,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *762 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + blocked_user: *764 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153465,11 +154003,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *762 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + blocked_user: *764 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153548,9 +154086,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - membership: &778 + enterprise: *742 + installation: *743 + membership: &780 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -153657,8 +154195,8 @@ x-webhooks: - role - organization_url - user - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153736,11 +154274,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *740 - installation: *741 - membership: *778 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + membership: *780 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153819,8 +154357,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -153936,10 +154474,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 - user: *762 + user: *764 required: - action - invitation @@ -154017,11 +154555,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *740 - installation: *741 - membership: *778 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + membership: *780 + organization: *744 + repository: *745 sender: *4 required: - action @@ -154108,11 +154646,11 @@ x-webhooks: properties: from: type: string - enterprise: *740 - installation: *741 - membership: *778 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + membership: *780 + organization: *744 + repository: *745 sender: *4 required: - action @@ -154189,9 +154727,9 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 package: description: Information about the package. type: object @@ -154690,7 +155228,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &779 + items: &781 title: Ruby Gems metadata type: object properties: @@ -154785,7 +155323,7 @@ x-webhooks: - owner - package_version - registry - repository: *743 + repository: *745 sender: *4 required: - action @@ -154861,9 +155399,9 @@ x-webhooks: type: string enum: - updated - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 package: description: Information about the package. type: object @@ -155216,7 +155754,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 source_url: type: string format: uri @@ -155286,7 +155824,7 @@ x-webhooks: - owner - package_version - registry - repository: *743 + repository: *745 sender: *4 required: - action @@ -155462,12 +156000,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *740 + enterprise: *742 id: type: integer - installation: *741 - organization: *742 - repository: *743 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - id @@ -155544,7 +156082,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &780 + personal_access_token_request: &782 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -155690,10 +156228,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *740 - organization: *742 + enterprise: *742 + organization: *744 sender: *4 - installation: *741 + installation: *743 required: - action - personal_access_token_request @@ -155770,11 +156308,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *780 - enterprise: *740 - organization: *742 + personal_access_token_request: *782 + enterprise: *742 + organization: *744 sender: *4 - installation: *741 + installation: *743 required: - action - personal_access_token_request @@ -155850,11 +156388,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *780 - enterprise: *740 - organization: *742 + personal_access_token_request: *782 + enterprise: *742 + organization: *744 sender: *4 - installation: *741 + installation: *743 required: - action - personal_access_token_request @@ -155929,11 +156467,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *780 - organization: *742 - enterprise: *740 + personal_access_token_request: *782 + organization: *744 + enterprise: *742 sender: *4 - installation: *741 + installation: *743 required: - action - personal_access_token_request @@ -156038,7 +156576,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *781 + last_response: *783 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -156070,8 +156608,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 zen: description: Random string of GitHub zen. @@ -156316,10 +156854,10 @@ x-webhooks: - from required: - note - enterprise: *740 - installation: *741 - organization: *742 - project_card: &782 + enterprise: *742 + installation: *743 + organization: *744 + project_card: &784 title: Project Card type: object properties: @@ -156438,7 +156976,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *743 + repository: *745 sender: *4 required: - action @@ -156519,11 +157057,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - project_card: *782 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project_card: *784 + repository: *745 sender: *4 required: - action @@ -156603,9 +157141,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 project_card: title: Project Card type: object @@ -156733,8 +157271,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *775 - required: *776 + properties: *777 + required: *778 nullable: true sender: *4 required: @@ -156828,11 +157366,11 @@ x-webhooks: - from required: - note - enterprise: *740 - installation: *741 - organization: *742 - project_card: *782 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project_card: *784 + repository: *745 sender: *4 required: - action @@ -156926,9 +157464,9 @@ x-webhooks: - from required: - column_id - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 project_card: allOf: - title: Project Card @@ -157118,7 +157656,7 @@ x-webhooks: type: string required: - after_id - repository: *743 + repository: *745 sender: *4 required: - action @@ -157198,10 +157736,10 @@ x-webhooks: type: string enum: - closed - enterprise: *740 - installation: *741 - organization: *742 - project: &784 + enterprise: *742 + installation: *743 + organization: *744 + project: &786 title: Project type: object properties: @@ -157325,7 +157863,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *743 + repository: *745 sender: *4 required: - action @@ -157405,10 +157943,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - project_column: &783 + enterprise: *742 + installation: *743 + organization: *744 + project_column: &785 title: Project Column type: object properties: @@ -157447,7 +157985,7 @@ x-webhooks: - name - created_at - updated_at - repository: *743 + repository: *745 sender: *4 required: - action @@ -157526,18 +158064,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - project_column: *783 + enterprise: *742 + installation: *743 + organization: *744 + project_column: *785 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *775 - required: *776 + properties: *777 + required: *778 nullable: true sender: *4 required: @@ -157627,11 +158165,11 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 - project_column: *783 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project_column: *785 + repository: *745 sender: *4 required: - action @@ -157711,11 +158249,11 @@ x-webhooks: type: string enum: - moved - enterprise: *740 - installation: *741 - organization: *742 - project_column: *783 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project_column: *785 + repository: *745 sender: *4 required: - action @@ -157795,11 +158333,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - project: *784 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project: *786 + repository: *745 sender: *4 required: - action @@ -157879,18 +158417,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - project: *784 + enterprise: *742 + installation: *743 + organization: *744 + project: *786 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *775 - required: *776 + properties: *777 + required: *778 nullable: true sender: *4 required: @@ -157992,11 +158530,11 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 - project: *784 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project: *786 + repository: *745 sender: *4 required: - action @@ -158075,11 +158613,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *740 - installation: *741 - organization: *742 - project: *784 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project: *786 + repository: *745 sender: *4 required: - action @@ -158160,9 +158698,9 @@ x-webhooks: type: string enum: - closed - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -158243,9 +158781,9 @@ x-webhooks: type: string enum: - created - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -158326,9 +158864,9 @@ x-webhooks: type: string enum: - deleted - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -158445,9 +158983,9 @@ x-webhooks: type: string to: type: string - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -158530,7 +159068,7 @@ x-webhooks: type: string enum: - archived - changes: &788 + changes: &790 type: object properties: archived_at: @@ -158544,9 +159082,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *741 - organization: *742 - projects_v2_item: &785 + installation: *743 + organization: *744 + projects_v2_item: &787 title: Projects v2 Item description: An item belonging to a project type: object @@ -158564,7 +159102,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *283 + content_type: *285 creator: *4 created_at: type: string @@ -158681,9 +159219,9 @@ x-webhooks: nullable: true to: type: string - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158765,9 +159303,9 @@ x-webhooks: type: string enum: - created - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158848,9 +159386,9 @@ x-webhooks: type: string enum: - deleted - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158956,7 +159494,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &786 + - &788 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -158978,7 +159516,7 @@ x-webhooks: required: - id - name - - &787 + - &789 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -159012,8 +159550,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *786 - - *787 + - *788 + - *789 required: - field_value - type: object @@ -159029,9 +159567,9 @@ x-webhooks: nullable: true required: - body - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -159126,9 +159664,9 @@ x-webhooks: to: type: string nullable: true - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -159211,10 +159749,10 @@ x-webhooks: type: string enum: - restored - changes: *788 - installation: *741 - organization: *742 - projects_v2_item: *785 + changes: *790 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -159296,9 +159834,9 @@ x-webhooks: type: string enum: - reopened - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -159379,14 +159917,14 @@ x-webhooks: type: string enum: - created - installation: *741 - organization: *742 - projects_v2_status_update: &791 + installation: *743 + organization: *744 + projects_v2_status_update: &793 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *789 - required: *790 + properties: *791 + required: *792 sender: *4 required: - action @@ -159467,9 +160005,9 @@ x-webhooks: type: string enum: - deleted - installation: *741 - organization: *742 - projects_v2_status_update: *791 + installation: *743 + organization: *744 + projects_v2_status_update: *793 sender: *4 required: - action @@ -159605,9 +160143,9 @@ x-webhooks: type: string format: date nullable: true - installation: *741 - organization: *742 - projects_v2_status_update: *791 + installation: *743 + organization: *744 + projects_v2_status_update: *793 sender: *4 required: - action @@ -159678,10 +160216,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - repository @@ -159758,13 +160296,13 @@ x-webhooks: type: string enum: - assigned - assignee: *762 - enterprise: *740 - installation: *741 - number: &792 + assignee: *764 + enterprise: *742 + installation: *743 + number: &794 description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -162069,7 +162607,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -162151,11 +162689,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -164455,7 +164993,7 @@ x-webhooks: - draft reason: type: string - repository: *743 + repository: *745 sender: *4 required: - action @@ -164537,11 +165075,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -166841,7 +167379,7 @@ x-webhooks: - draft reason: type: string - repository: *743 + repository: *745 sender: *4 required: - action @@ -166923,13 +167461,13 @@ x-webhooks: type: string enum: - closed - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: &793 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: &795 allOf: - - *596 + - *598 - type: object properties: allow_auto_merge: @@ -166991,7 +167529,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *743 + repository: *745 sender: *4 required: - action @@ -167072,12 +167610,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -167157,11 +167695,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *740 - milestone: *580 - number: *792 - organization: *742 - pull_request: &794 + enterprise: *742 + milestone: *582 + number: *794 + organization: *744 + pull_request: &796 title: Pull Request type: object properties: @@ -169446,7 +169984,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -169525,11 +170063,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -171833,7 +172371,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *743 + repository: *745 sender: *4 required: - action @@ -171957,12 +172495,12 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -172042,11 +172580,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -174335,7 +174873,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -174415,11 +174953,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *740 - installation: *741 - label: *761 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + label: *763 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -176723,7 +177261,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -176804,10 +177342,10 @@ x-webhooks: type: string enum: - locked - enterprise: *740 - installation: *741 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -179109,7 +179647,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -179189,12 +179727,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *740 - milestone: *580 - number: *792 - organization: *742 - pull_request: *794 - repository: *743 + enterprise: *742 + milestone: *582 + number: *794 + organization: *744 + pull_request: *796 + repository: *745 sender: *4 required: - action @@ -179273,12 +179811,12 @@ x-webhooks: type: string enum: - opened - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -179359,12 +179897,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -179444,12 +179982,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -179815,9 +180353,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: type: object properties: @@ -182009,7 +182547,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *743 + repository: *745 sender: *4 required: - action @@ -182089,7 +182627,7 @@ x-webhooks: type: string enum: - deleted - comment: &796 + comment: &798 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -182374,9 +182912,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: type: object properties: @@ -184556,7 +185094,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *743 + repository: *745 sender: *4 required: - action @@ -184636,11 +185174,11 @@ x-webhooks: type: string enum: - edited - changes: *795 - comment: *796 - enterprise: *740 - installation: *741 - organization: *742 + changes: *797 + comment: *798 + enterprise: *742 + installation: *743 + organization: *744 pull_request: type: object properties: @@ -186823,7 +187361,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *743 + repository: *745 sender: *4 required: - action @@ -186904,9 +187442,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -189101,7 +189639,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 + repository: *745 review: description: The review that was affected. type: object @@ -189348,9 +189886,9 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -191404,8 +191942,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 - review: &797 + repository: *745 + review: &799 description: The review that was affected. type: object properties: @@ -191638,12 +192176,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -193948,7 +194486,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 requested_reviewer: title: User type: object @@ -194032,12 +194570,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -196349,7 +196887,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 requested_team: title: Team description: Groups of organization members that gives permissions @@ -196541,12 +197079,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -198853,7 +199391,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 requested_reviewer: title: User type: object @@ -198938,12 +199476,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -201241,7 +201779,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 requested_team: title: Team description: Groups of organization members that gives permissions @@ -201422,9 +201960,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -203621,8 +204159,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 - review: *797 + repository: *745 + review: *799 sender: *4 required: - action @@ -203702,9 +204240,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -205796,7 +206334,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 + repository: *745 sender: *4 thread: type: object @@ -206183,9 +206721,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -208263,7 +208801,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 + repository: *745 sender: *4 thread: type: object @@ -208653,10 +209191,10 @@ x-webhooks: type: string before: type: string - enterprise: *740 - installation: *741 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -210949,7 +211487,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -211031,11 +211569,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *798 - enterprise: *740 - installation: *741 - number: *792 - organization: *742 + assignee: *800 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -213340,7 +213878,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -213419,11 +213957,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *740 - installation: *741 - label: *761 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + label: *763 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -215718,7 +216256,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -215799,10 +216337,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *740 - installation: *741 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -218089,7 +218627,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -218289,7 +218827,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *740 + enterprise: *742 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -218381,8 +218919,8 @@ x-webhooks: - url - author - committer - installation: *741 - organization: *742 + installation: *743 + organization: *744 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -218968,9 +219506,9 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 registry_package: type: object properties: @@ -219416,7 +219954,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -219470,7 +220008,7 @@ x-webhooks: - owner - package_version - registry - repository: *743 + repository: *745 sender: *4 required: - action @@ -219548,9 +220086,9 @@ x-webhooks: type: string enum: - updated - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 registry_package: type: object properties: @@ -219858,7 +220396,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -219907,7 +220445,7 @@ x-webhooks: - owner - package_version - registry - repository: *743 + repository: *745 sender: *4 required: - action @@ -219984,10 +220522,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - release: &799 + enterprise: *742 + installation: *743 + organization: *744 + release: &801 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -220305,7 +220843,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *743 + repository: *745 sender: *4 required: - action @@ -220382,11 +220920,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - release: *799 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + release: *801 + repository: *745 sender: *4 required: - action @@ -220503,11 +221041,11 @@ x-webhooks: type: boolean required: - to - enterprise: *740 - installation: *741 - organization: *742 - release: *799 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + release: *801 + repository: *745 sender: *4 required: - action @@ -220585,9 +221123,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -220909,7 +221447,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *743 + repository: *745 sender: *4 required: - action @@ -220985,10 +221523,10 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 - release: &800 + enterprise: *742 + installation: *743 + organization: *744 + release: &802 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -221307,7 +221845,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *743 + repository: *745 sender: *4 required: - action @@ -221383,11 +221921,11 @@ x-webhooks: type: string enum: - released - enterprise: *740 - installation: *741 - organization: *742 - release: *799 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + release: *801 + repository: *745 sender: *4 required: - action @@ -221463,11 +222001,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *740 - installation: *741 - organization: *742 - release: *800 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + release: *802 + repository: *745 sender: *4 required: - action @@ -221543,11 +222081,11 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_advisory: *663 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_advisory: *665 sender: *4 required: - action @@ -221623,11 +222161,11 @@ x-webhooks: type: string enum: - reported - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_advisory: *663 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_advisory: *665 sender: *4 required: - action @@ -221703,10 +222241,10 @@ x-webhooks: type: string enum: - archived - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221783,10 +222321,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221864,10 +222402,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221951,10 +222489,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222066,10 +222604,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222141,10 +222679,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 status: type: string @@ -222225,10 +222763,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222305,10 +222843,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222402,10 +222940,10 @@ x-webhooks: - name required: - repository - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222485,11 +223023,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_ruleset: *324 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_ruleset: *326 sender: *4 required: - action @@ -222567,11 +223105,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_ruleset: *324 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_ruleset: *326 sender: *4 required: - action @@ -222649,11 +223187,11 @@ x-webhooks: type: string enum: - edited - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_ruleset: *324 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_ruleset: *326 changes: type: object properties: @@ -222672,16 +223210,16 @@ x-webhooks: properties: added: type: array - items: *298 + items: *300 deleted: type: array - items: *298 + items: *300 updated: type: array items: type: object properties: - condition: *298 + condition: *300 changes: type: object properties: @@ -222714,16 +223252,16 @@ x-webhooks: properties: added: type: array - items: *616 + items: *618 deleted: type: array - items: *616 + items: *618 updated: type: array items: type: object properties: - rule: *616 + rule: *618 changes: type: object properties: @@ -222957,10 +223495,10 @@ x-webhooks: - from required: - owner - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223038,10 +223576,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223119,7 +223657,7 @@ x-webhooks: type: string enum: - create - alert: &801 + alert: &803 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -223241,10 +223779,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223450,10 +223988,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223531,11 +224069,11 @@ x-webhooks: type: string enum: - reopen - alert: *801 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *803 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223734,10 +224272,10 @@ x-webhooks: enum: - fixed - open - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223815,11 +224353,11 @@ x-webhooks: type: string enum: - assigned - alert: &802 + alert: &804 type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -223827,8 +224365,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri @@ -223958,10 +224496,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -224039,11 +224577,11 @@ x-webhooks: type: string enum: - created - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -224124,11 +224662,11 @@ x-webhooks: type: string enum: - created - alert: *802 - installation: *741 - location: *803 - organization: *742 - repository: *743 + alert: *804 + installation: *743 + location: *805 + organization: *744 + repository: *745 sender: *4 required: - location @@ -224366,11 +224904,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -224448,11 +224986,11 @@ x-webhooks: type: string enum: - reopened - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -224530,11 +225068,11 @@ x-webhooks: type: string enum: - resolved - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -224612,12 +225150,12 @@ x-webhooks: type: string enum: - unassigned - alert: *802 + alert: *804 assignee: *4 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -224695,11 +225233,11 @@ x-webhooks: type: string enum: - validated - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -224825,10 +225363,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *743 - enterprise: *740 - installation: *741 - organization: *742 + repository: *745 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -224906,11 +225444,11 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - security_advisory: &804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + security_advisory: &806 description: The details of the security advisory, including summary, description, and severity. type: object @@ -225093,11 +225631,11 @@ x-webhooks: type: string enum: - updated - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - security_advisory: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + security_advisory: *806 sender: *4 required: - action @@ -225170,10 +225708,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -225357,11 +225895,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *297 - enterprise: *740 - installation: *741 - organization: *742 - repository: *345 + security_and_analysis: *299 + enterprise: *742 + installation: *743 + organization: *744 + repository: *347 sender: *4 required: - changes @@ -225439,12 +225977,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: &805 + sponsorship: &807 type: object properties: created_at: @@ -225745,12 +226283,12 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - sponsorship @@ -225838,12 +226376,12 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - changes @@ -225920,17 +226458,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &806 + effective_date: &808 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - sponsorship @@ -226004,7 +226542,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &807 + changes: &809 type: object properties: tier: @@ -226048,13 +226586,13 @@ x-webhooks: - from required: - tier - effective_date: *806 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + effective_date: *808 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - changes @@ -226131,13 +226669,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *807 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + changes: *809 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - changes @@ -226211,10 +226749,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -226297,10 +226835,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -226720,15 +227258,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *740 + enterprise: *742 id: description: The unique identifier of the status. type: integer - installation: *741 + installation: *743 name: type: string - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 sha: description: The Commit SHA. @@ -226837,15 +227375,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - parent_issue_repo: *80 + parent_issue: *88 + parent_issue_repo: *82 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - installation: *741 - organization: *742 - repository: *743 + sub_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -226929,15 +227467,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - parent_issue_repo: *80 + parent_issue: *88 + parent_issue_repo: *82 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - installation: *741 - organization: *742 - repository: *743 + sub_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -227021,15 +227559,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - sub_issue_repo: *80 + sub_issue: *88 + sub_issue_repo: *82 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - installation: *741 - organization: *742 - repository: *743 + parent_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -227113,15 +227651,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - sub_issue_repo: *80 + sub_issue: *88 + sub_issue_repo: *82 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - installation: *741 - organization: *742 - repository: *743 + parent_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -227198,12 +227736,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - team: &808 + team: &810 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -227426,9 +227964,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -227886,7 +228424,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - team @@ -227962,9 +228500,9 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -228422,7 +228960,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - team @@ -228499,9 +229037,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -228959,7 +229497,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - team @@ -229103,9 +229641,9 @@ x-webhooks: - from required: - permissions - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -229563,7 +230101,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - changes @@ -229641,9 +230179,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -230101,7 +230639,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - team @@ -230177,10 +230715,10 @@ x-webhooks: type: string enum: - started - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -230253,16 +230791,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *740 + enterprise: *742 inputs: type: object nullable: true additionalProperties: true - installation: *741 - organization: *742 + installation: *743 + organization: *744 ref: type: string - repository: *743 + repository: *745 sender: *4 workflow: type: string @@ -230344,10 +230882,10 @@ x-webhooks: type: string enum: - completed - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 workflow_job: allOf: @@ -230584,7 +231122,7 @@ x-webhooks: type: string required: - conclusion - deployment: *506 + deployment: *508 required: - action - repository @@ -230663,10 +231201,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 workflow_job: allOf: @@ -230926,7 +231464,7 @@ x-webhooks: required: - status - steps - deployment: *506 + deployment: *508 required: - action - repository @@ -231005,10 +231543,10 @@ x-webhooks: type: string enum: - queued - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 workflow_job: type: object @@ -231143,7 +231681,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *506 + deployment: *508 required: - action - repository @@ -231222,10 +231760,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 workflow_job: type: object @@ -231361,7 +231899,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *506 + deployment: *508 required: - action - repository @@ -231441,12 +231979,12 @@ x-webhooks: type: string enum: - completed - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: *757 + workflow: *759 workflow_run: title: Workflow Run type: object @@ -232445,12 +232983,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: *757 + workflow: *759 workflow_run: title: Workflow Run type: object @@ -233434,12 +233972,12 @@ x-webhooks: type: string enum: - requested - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: *757 + workflow: *759 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 0d05e5b8bd..4780265edd 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -24849,17 +24853,17 @@ } } }, - "/enterprises/{enterprise}/teams": { + "/enterprises/{enterprise}/dependabot/repository-access": { "get": { - "summary": "List enterprise teams", - "description": "List all teams in the enterprise for the authenticated user", + "summary": "Lists the repositories Dependabot can access in an enterprise", + "description": "Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", "tags": [ - "enterprise-teams" + "dependabot" ], - "operationId": "enterprise-teams/list", + "operationId": "dependabot/repository-access-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" }, "parameters": [ { @@ -24872,21 +24876,26 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "page", "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { "type": "integer", - "default": 30 + "minimum": 1, + "default": 1 } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "per_page", "in": "query", + "description": "Number of results per page.", + "required": false, "schema": { "type": "integer", - "default": 1 + "minimum": 1, + "maximum": 100, + "default": 30 } } ], @@ -24896,106 +24905,1000 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "example": "disabled | all" - }, - "organization_selection_type": { - "type": "string", - "example": "disabled | selected | all" - }, - "group_id": { - "nullable": true, - "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "group_name": { - "nullable": true, - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "example": "Justice League" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/dc/teams/justice-league" - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" - ] - } + "accessible_repositories": { + "type": "array", + "items": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "nullable": true + } + } + }, + "additionalProperties": false }, "examples": { "default": { - "value": [ - { - "id": 1, - "name": "Justice League", - "description": "A great team.", - "slug": "justice-league", - "url": "https://api.github.com/enterprises/dc/teams/justice-league", - "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", - "html_url": "https://github.com/enterprises/dc/teams/justice-league", - "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", - "created_at": "2019-01-26T19:01:12Z", - "updated_at": "2019-01-26T19:14:43Z" - } - ] + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an enterprise", + "description": "Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot in an enterprise", + "description": "Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/teams": { + "get": { + "summary": "List enterprise teams", + "description": "List all teams in the enterprise for the authenticated user", + "tags": [ + "enterprise-teams" + ], + "operationId": "enterprise-teams/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "example": "disabled | all" + }, + "organization_selection_type": { + "type": "string", + "example": "disabled | selected | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" + }, + "group_name": { + "nullable": true, + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "example": "Justice League" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Justice League", + "description": "A great team.", + "slug": "justice-league", + "url": "https://api.github.com/enterprises/dc/teams/justice-league", + "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", + "html_url": "https://github.com/enterprises/dc/teams/justice-league", + "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", + "created_at": "2019-01-26T19:01:12Z", + "updated_at": "2019-01-26T19:14:43Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, "403": { @@ -74324,6 +75227,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -74387,6 +75294,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -96778,6 +97689,9 @@ "schema": { "type": "object", "additionalProperties": false, + "required": [ + "selected_repository_ids" + ], "properties": { "selected_repository_ids": { "type": "array", @@ -225324,6 +226238,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -225491,6 +226413,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -243624,7 +244550,7 @@ ], "responses": { "200": { - "description": "Response including the workflow run ID and URLs when `return_run_details` parameter is `true`.", + "description": "Response including the workflow run ID and URLs.", "content": { "application/json": { "schema": { @@ -519789,6 +520715,15 @@ "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", "type": "string", "nullable": true + }, + "validity": { + "type": "string", + "nullable": true, + "enum": [ + "active", + "inactive" + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -521036,7 +521971,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "description": "Service unavailable", @@ -922941,567 +923876,8117 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "type": "object", + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-demilestoned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues demilestoned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "demilestoned" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "pinned_at", - "pinned_by" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" ], - "nullable": true + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ "id", "node_id", + "owner", + "name", + "description", + "external_url", "html_url", - "issue_url", - "user", - "url", "created_at", - "updated_at" - ], - "nullable": true + "updated_at", + "permissions", + "events" + ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "total": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { "type": "integer" }, - "completed": { + "+1": { "type": "integer" }, - "percent_completed": { + "-1": { "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { + }, + "laugh": { "type": "integer" }, - "blocking": { + "confused": { "type": "integer" }, - "total_blocked_by": { + "heart": { "type": "integer" }, - "total_blocking": { + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { "type": "integer" } }, "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", + "pin": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", + "id": { + "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, - "node_id": { + "name": { + "description": "The name of the option", "type": "string", - "example": "IFT_GDKND" + "example": "High" }, - "data_type": { - "description": "The data type of the issue field", + "color": { + "description": "The color of the option", "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true + "example": "red" } }, "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] + "id", + "name", + "color" + ], + "nullable": true } }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "state_reason": { + "node_id": { "type": "string", - "nullable": true + "description": "The node identifier of the issue type." }, - "timeline_url": { + "name": { "type": "string", - "format": "uri" + "description": "The name of the issue type." }, - "title": { - "description": "Title of the issue", - "type": "string" + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, - "updated_at": { + "created_at": { "type": "string", + "description": "The time the issue type created.", "format": "date-time" }, - "url": { - "description": "URL for the issue", + "updated_at": { "type": "string", - "format": "uri" + "description": "The time the issue type last updated.", + "format": "date-time" }, - "user": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "name", + "description" ] }, - { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "active_lock_reason": { + "avatar_url": { "type": "string", - "nullable": true + "format": "uri" }, - "assignee": { - "type": "object", - "nullable": true + "deleted": { + "type": "boolean" }, - "assignees": { - "type": "array", - "items": { - "type": "object", - "nullable": true - } + "email": { + "type": "string", + "nullable": true }, - "author_association": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "body": { + "followers_url": { "type": "string", - "nullable": true + "format": "uri" }, - "closed_at": { + "following_url": { "type": "string", - "nullable": true + "format": "uri-template" }, - "comments": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "comments_url": { + "gravatar_id": { "type": "string" }, - "created_at": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, - "events_url": { + "name": { "type": "string" }, - "html_url": { + "node_id": { "type": "string" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "labels": { - "type": "array", - "items": { - "type": "object", - "nullable": true - } + "received_events_url": { + "type": "string", + "format": "uri" }, - "labels_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "locked": { + "site_admin": { "type": "boolean" }, - "milestone": { - "type": "object", - "nullable": true + "starred_url": { + "type": "string", + "format": "uri-template" }, - "node_id": { + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { "type": "string" + } + } + } + } + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "number": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "performed_via_github_app": { - "type": "object", + "email": { + "type": "string", "nullable": true }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } + "events_url": { + "type": "string", + "format": "uri-template" }, - "repository_url": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "state": { + "html_url": { "type": "string", - "enum": [ - "closed", - "open" - ] + "format": "uri" }, - "timeline_url": { + "id": { + "type": "integer" + }, + "login": { "type": "string" }, - "title": { + "name": { "type": "string" }, - "updated_at": { + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user_view_type": { - "type": "string" - } - } + "user_view_type": { + "type": "string" } }, "required": [ - "state", - "closed_at" + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -924948,11 +933433,11 @@ } } }, - "issues-deleted": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -925019,15 +933504,45 @@ "content": { "application/json": { "schema": { - "title": "issues deleted event", + "title": "issues edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "edited" ] }, + "changes": { + "description": "The changes to the issue.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -925212,7 +933727,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -925309,15 +933825,13 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } }, "required": [ @@ -925525,7 +934039,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -925683,6 +934198,8 @@ "watch", "workflow_dispatch", "workflow_run", + "security_and_analysis", + "pull_request_review_thread", "reminder" ] } @@ -925930,7 +934447,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -926994,10 +935512,6 @@ "type": "string", "format": "uri" }, - "title": { - "description": "Title of the issue", - "type": "string" - }, "type": { "title": "Issue Type", "description": "The type of issue.", @@ -927058,6 +935572,10 @@ "description" ] }, + "title": { + "description": "Title of the issue", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time" @@ -927147,7 +935665,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -927188,6 +935707,47 @@ "reactions" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -928607,6 +937167,7 @@ }, "required": [ "action", + "changes", "issue", "repository", "sender" @@ -928632,11 +937193,11 @@ } } }, - "issues-demilestoned": { + "issues-field-added": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue field value was set or updated on an issue.", + "operationId": "issues/field-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -928703,13 +937264,13 @@ "content": { "application/json": { "schema": { - "title": "issues demilestoned event", + "title": "issues field_added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "demilestoned" + "field_added" ] }, "enterprise": { @@ -928805,29 +937366,6 @@ "title": "Issue", "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", "type": "object", - "required": [ - "active_lock_reason", - "assignees", - "author_association", - "body", - "closed_at", - "comments", - "comments_url", - "created_at", - "events_url", - "html_url", - "id", - "labels_url", - "milestone", - "node_id", - "number", - "reactions", - "repository_url", - "title", - "updated_at", - "url", - "user" - ], "properties": { "active_lock_reason": { "type": "string", @@ -928844,10 +937382,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -928930,8 +937464,15 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "assignees": { "type": "array", @@ -928939,10 +937480,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -929025,8 +937562,15 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "login", + "id" + ] } }, "author_association": { @@ -929085,16 +937629,6 @@ "items": { "title": "Label", "type": "object", - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ], - "nullable": true, "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", @@ -929122,7 +937656,16 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] } }, "labels_url": { @@ -929137,24 +937680,6 @@ "description": "A collection of related issues and pull requests.", "type": "object", "nullable": true, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ], "properties": { "closed_at": { "type": "string", @@ -929172,10 +937697,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -929262,7 +937783,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "description": { "type": "string", @@ -929314,7 +937839,25 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, "node_id": { "type": "string" @@ -929327,17 +937870,6 @@ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ], "properties": { "created_at": { "type": "string", @@ -929398,7 +937930,9 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run" + "workflow_run", + "reminder", + "pull_request_review_thread" ] } }, @@ -929427,10 +937961,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -929516,7 +938046,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "permissions": { "description": "The set of permissions for the GitHub app", @@ -929772,7 +938306,18 @@ "nullable": true, "format": "date-time" } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] }, "pull_request": { "type": "object", @@ -929803,18 +938348,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -929847,7 +938380,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "repository_url": { "type": "string", @@ -930776,10 +939321,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -930867,193 +939408,183 @@ "user_view_type": { "type": "string" } - } - } - } - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } }, "required": [ "login", "id" ] - }, - "description": { - "type": "string", - "nullable": true - }, - "due_on": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was set or updated on the issue.", + "properties": { "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue field." }, - "labels_url": { + "name": { "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" + "description": "The name of the issue field." }, - "state": { - "description": "The state of the milestone.", + "field_type": { "type": "string", + "description": "The data type of the issue field.", "enum": [ - "open", - "closed" + "text", + "date", + "single_select", + "number" ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was set or updated for the issue field. When updating an existing value, the previous value is available in `changes`.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] }, - "updated_at": { - "type": "string", - "format": "date-time" + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." }, - "url": { - "type": "string", - "format": "uri" + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } } }, "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" + "id" ] }, + "changes": { + "type": "object", + "description": "The previous field value, present when an existing value was updated.", + "properties": { + "issue_field_value": { + "type": "object", + "description": "The previous issue field value data.", + "properties": { + "from": { + "type": "object", + "description": "The previous value of the issue field before the update.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The previous value. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the previously selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The previously selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "from" + ] + } + } + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -932474,6 +941005,7 @@ "required": [ "action", "issue", + "issue_field", "repository", "sender" ] @@ -932498,11 +941030,11 @@ } } }, - "issues-edited": { + "issues-field-removed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue field value was cleared from an issue.", + "operationId": "issues/field-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -932569,45 +941101,15 @@ "content": { "application/json": { "schema": { - "title": "issues edited event", + "title": "issues field_removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "field_removed" ] }, - "changes": { - "description": "The changes to the issue.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "title": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the title.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -932897,6 +941399,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -933263,9 +941768,8 @@ "watch", "workflow_dispatch", "workflow_run", - "security_and_analysis", - "pull_request_review_thread", - "reminder" + "reminder", + "pull_request_review_thread" ] } }, @@ -934577,6 +943081,10 @@ "type": "string", "format": "uri" }, + "title": { + "description": "Title of the issue", + "type": "string" + }, "type": { "title": "Issue Type", "description": "The type of issue.", @@ -934637,10 +943145,6 @@ "description" ] }, - "title": { - "description": "Title of the issue", - "type": "string" - }, "updated_at": { "type": "string", "format": "date-time" @@ -934772,45 +943276,84 @@ "reactions" ] }, - "label": { - "title": "Label", + "issue_field": { "type": "object", + "description": "The issue field whose value was cleared from the issue.", "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": "string", - "nullable": true - }, "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue field." }, "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" + "type": "string", + "description": "The name of the issue field." }, - "url": { - "description": "URL for the label", + "field_type": { "type": "string", - "format": "uri" + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] } }, "required": [ "id", - "node_id", - "url", "name", - "color", - "default", - "description" + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was cleared from the issue field.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" ] }, "organization": { @@ -936232,8 +944775,8 @@ }, "required": [ "action", - "changes", "issue", + "issue_field", "repository", "sender" ] diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index adeb1df704..193b20a037 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -73,6 +73,9 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot @@ -829,7 +832,7 @@ paths: - subscriptions_url - type - url - type: &330 + type: &332 type: string description: The type of credit the user is receiving. enum: @@ -961,7 +964,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &129 + schema: &131 title: Validation Error Simple description: Validation Error Simple type: object @@ -994,7 +997,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &665 + - &667 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1109,7 +1112,7 @@ paths: GitHub. type: object nullable: true - properties: &81 + properties: &83 id: description: Unique identifier of the GitHub app example: 37 @@ -1242,7 +1245,7 @@ paths: about itself. example: 5 type: integer - required: &82 + required: &84 - id - node_id - owner @@ -1547,7 +1550,7 @@ paths: schema: type: integer default: 30 - - &216 + - &218 name: cursor 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 @@ -1556,7 +1559,7 @@ paths: required: false schema: type: string - - &217 + - &219 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1576,7 +1579,7 @@ paths: application/json: schema: type: array - items: &218 + items: &220 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1656,7 +1659,7 @@ paths: - installation_id - repository_id examples: - default: &219 + default: &221 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1715,7 +1718,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &128 + schema: &130 title: Validation Error description: Validation Error type: object @@ -1784,7 +1787,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &222 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1898,7 +1901,7 @@ paths: - request - response examples: - default: &221 + default: &223 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2099,7 +2102,7 @@ paths: parameters: - *17 - *19 - - &93 + - &95 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2682,7 +2685,7 @@ paths: suspended_at: suspended_by: headers: - Link: &68 + Link: &70 example: ; rel="next", ; rel="last" schema: @@ -2871,11 +2874,11 @@ paths: - selected repositories: type: array - items: &80 + items: &82 title: Repository description: A repository on GitHub. type: object - properties: &295 + properties: &297 id: description: Unique identifier of the repository example: 42 @@ -2895,7 +2898,7 @@ paths: title: License Simple description: License Simple type: object - properties: &89 + properties: &91 key: type: string example: mit @@ -2917,7 +2920,7 @@ paths: html_url: type: string format: uri - required: &90 + required: &92 - key - name - url @@ -3311,7 +3314,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &296 + required: &298 - archive_url - assignees_url - blobs_url @@ -7251,7 +7254,7 @@ paths: required: true content: application/json: - schema: &141 + schema: &143 title: Actions OIDC Custom Property Inclusion Input description: Input for creating an OIDC custom property inclusion type: object @@ -7951,7 +7954,7 @@ paths: description: Response content: application/json: - schema: &188 + schema: &190 type: array description: A list of default code security configurations items: @@ -7967,7 +7970,7 @@ paths: default configuration: *49 examples: - default: &189 + default: &191 value: - default_for_new_repos: public configuration: @@ -8429,7 +8432,7 @@ paths: default: value: default_for_new_repos: all - configuration: &187 + configuration: &189 value: id: 1325 target_type: organization @@ -8519,7 +8522,7 @@ paths: application/json: schema: type: array - items: &190 + items: &192 type: object description: Repositories associated with a code security configuration and attachment status @@ -8541,7 +8544,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &208 + properties: &68 id: type: integer format: int64 @@ -8768,7 +8771,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &209 + required: &69 - archive_url - assignees_url - blobs_url @@ -8820,7 +8823,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &191 + repository: &193 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -9325,7 +9328,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &197 + - &199 name: classification in: query description: |- @@ -9334,7 +9337,7 @@ paths: Can be: `malware`, `general` schema: type: string - - &198 + - &200 name: state in: query description: |- @@ -9343,7 +9346,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &199 + - &201 name: severity in: query description: |- @@ -9352,7 +9355,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &200 + - &202 name: ecosystem in: query description: |- @@ -9361,14 +9364,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &201 + - &203 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &202 + - &204 name: epss_percentage in: query description: |- @@ -9380,7 +9383,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &495 + - &497 name: has in: query description: |- @@ -9394,7 +9397,7 @@ paths: type: string enum: - patch - - &203 + - &205 name: assignee in: query description: |- @@ -9403,7 +9406,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &204 + - &206 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9413,7 +9416,7 @@ paths: enum: - development - runtime - - &205 + - &207 name: sort in: query description: |- @@ -9439,11 +9442,11 @@ paths: application/json: schema: type: array - items: &206 + items: &208 type: object description: A Dependabot alert. properties: - number: &177 + number: &179 type: integer description: The security alert number. readOnly: true @@ -9506,7 +9509,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &496 + security_advisory: &498 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9694,29 +9697,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *66 - url: &180 + url: &182 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &181 + html_url: &183 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &178 + created_at: &180 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &179 + updated_at: &181 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &183 + dismissed_at: &185 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9746,21 +9749,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &182 + fixed_at: &184 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &497 + auto_dismissed_at: &499 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &498 + dismissal_request: &500 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -9822,7 +9825,7 @@ paths: - repository additionalProperties: false examples: - default: &207 + default: &209 value: - number: 2 state: dismissed @@ -10170,6 +10173,266 @@ paths: previews: [] category: dependabot subcategory: alerts + "/enterprises/{enterprise}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an enterprise + description: |- + Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise + parameters: + - *40 + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: &210 + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able + to access in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + title: Simple Repository + description: A GitHub repository. + type: object + properties: *68 + required: *69 + nullable: true + additionalProperties: false + examples: + default: &211 + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an enterprise + description: |- + Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise + parameters: + - *40 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + "/enterprises/{enterprise}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot in an enterprise + description: |- + Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise + parameters: + - *40 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -10191,7 +10454,7 @@ paths: application/json: schema: type: array - items: &69 + items: &71 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -10262,7 +10525,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -10335,9 +10598,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: &77 + default: &79 value: id: 1 name: Justice League @@ -10366,7 +10629,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *40 - - &70 + - &72 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -10385,7 +10648,7 @@ paths: type: array items: *4 examples: - default: &71 + default: &73 value: - login: octocat id: 1 @@ -10406,7 +10669,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10424,7 +10687,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10455,7 +10718,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10473,7 +10736,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10504,7 +10767,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10522,8 +10785,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *40 - - *70 - - &72 + - *72 + - &74 name: username description: The handle for the GitHub user account. in: path @@ -10537,7 +10800,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &73 + exampleKey1: &75 value: login: octocat id: 1 @@ -10573,8 +10836,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *40 - - *70 - *72 + - *74 responses: '201': description: Successfully added team member @@ -10582,7 +10845,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *73 + exampleKey1: *75 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10600,8 +10863,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *40 - - *70 - *72 + - *74 responses: '204': description: Response @@ -10623,7 +10886,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *40 - - *70 + - *72 - *17 - *19 responses: @@ -10633,11 +10896,11 @@ paths: application/json: schema: type: array - items: &74 + items: &76 title: Organization Simple description: A GitHub organization. type: object - properties: &193 + properties: &195 login: type: string example: github @@ -10678,7 +10941,7 @@ paths: type: string example: A great organization nullable: true - required: &194 + required: &196 - login - url - id @@ -10692,7 +10955,7 @@ paths: - avatar_url - description examples: - default: &75 + default: &77 value: login: github id: 1 @@ -10723,7 +10986,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10751,9 +11014,9 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: &117 + default: &119 value: - login: github id: 1 @@ -10784,7 +11047,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10825,8 +11088,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *40 - - *70 - - &76 + - *72 + - &78 name: org description: The organization name. The name is not case sensitive. in: path @@ -10838,9 +11101,9 @@ paths: description: The team is assigned to the organization content: application/json: - schema: *74 + schema: *76 examples: - default: *75 + default: *77 '404': description: The team is not assigned to the organization x-github: @@ -10859,16 +11122,16 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *40 - - *70 - - *76 + - *72 + - *78 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *74 + schema: *76 examples: - default: *75 + default: *77 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10885,8 +11148,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *40 - - *70 - - *76 + - *72 + - *78 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -10910,7 +11173,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *40 - - &78 + - &80 name: team_slug description: The slug of the team name. in: path @@ -10922,11 +11185,11 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: *77 + default: *79 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -10944,7 +11207,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *40 - - *78 + - *80 requestBody: required: true content: @@ -10999,11 +11262,11 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: *77 + default: *79 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -11024,7 +11287,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *40 - - *78 + - *80 responses: '204': description: Response @@ -11062,7 +11325,7 @@ paths: application/json: schema: type: array - items: &112 + items: &114 title: Event description: Event type: object @@ -11072,7 +11335,7 @@ paths: type: type: string nullable: true - actor: &79 + actor: &81 title: Actor description: Actor type: object @@ -11112,7 +11375,7 @@ paths: - id - name - url - org: *79 + org: *81 payload: oneOf: - title: CreateEvent @@ -11158,7 +11421,7 @@ paths: properties: action: type: string - discussion: &758 + discussion: &760 title: Discussion description: A Discussion in a repository. type: object @@ -11445,7 +11708,7 @@ paths: - id labels: type: array - items: &85 + items: &87 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -11520,12 +11783,12 @@ paths: properties: action: type: string - issue: &86 + issue: &88 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &550 + properties: &552 id: type: integer format: int64 @@ -11631,7 +11894,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &279 + properties: &281 url: type: string format: uri @@ -11701,7 +11964,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &280 + required: &282 - closed_issues - creator - description @@ -11780,7 +12043,7 @@ paths: timeline_url: type: string format: uri - type: &242 + type: &244 title: Issue Type description: The type of issue. type: object @@ -11830,7 +12093,7 @@ paths: - node_id - name - description - repository: *80 + repository: *82 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -11841,9 +12104,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - author_association: &83 + properties: *83 + required: *84 + author_association: &85 title: author_association type: string example: OWNER @@ -11858,7 +12121,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &84 + reactions: &86 title: Reaction Rollup type: object properties: @@ -11894,7 +12157,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &676 + sub_issues_summary: &678 title: Sub-issues Summary type: object properties: @@ -11919,7 +12182,7 @@ paths: description: Comments provide a way for people to collaborate on an issue. type: object - properties: &87 + properties: &89 id: description: Unique identifier of the issue comment example: 42 @@ -11962,7 +12225,7 @@ paths: issue_url: type: string format: uri - author_association: *83 + author_association: *85 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend @@ -11973,15 +12236,15 @@ paths: class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - reactions: *84 + properties: *83 + required: *84 + reactions: *86 pin: title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &573 + properties: &575 pinned_at: type: string format: date-time @@ -11993,11 +12256,11 @@ paths: properties: *20 required: *21 nullable: true - required: &574 + required: &576 - pinned_at - pinned_by nullable: true - required: &88 + required: &90 - id - node_id - html_url @@ -12007,7 +12270,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &677 + issue_dependencies_summary: &679 title: Issue Dependencies Summary type: object properties: @@ -12026,7 +12289,7 @@ paths: - total_blocking issue_field_values: type: array - items: &557 + items: &559 title: Issue Field Value description: A value assigned to an issue field type: object @@ -12087,7 +12350,7 @@ paths: - node_id - data_type - value - required: &551 + required: &553 - closed_at - comments - comments_url @@ -12111,10 +12374,10 @@ paths: assignees: type: array items: *4 - label: *85 + label: *87 labels: type: array - items: *85 + items: *87 required: - action - issue @@ -12123,14 +12386,14 @@ paths: properties: action: type: string - issue: *86 - comment: &546 + issue: *88 + comment: &548 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 required: - action - issue @@ -12303,8 +12566,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true allow_forking: type: boolean @@ -12393,7 +12656,7 @@ paths: type: string number: type: integer - pull_request: &91 + pull_request: &93 title: Pull Request Minimal type: object properties: @@ -12464,10 +12727,10 @@ paths: assignees: type: array items: *4 - label: *85 + label: *87 labels: type: array - items: *85 + items: *87 required: - action - number @@ -12477,7 +12740,7 @@ paths: properties: action: type: string - pull_request: *91 + pull_request: *93 comment: type: object properties: @@ -12728,7 +12991,7 @@ paths: - pull_request updated_at: type: string - pull_request: *91 + pull_request: *93 required: - action - review @@ -12777,7 +13040,7 @@ paths: updated_at: type: string format: date-time - reactions: *84 + reactions: *86 required: - action - comment @@ -12788,7 +13051,7 @@ paths: type: string release: allOf: - - &607 + - &609 title: Release description: A release. type: object @@ -12859,7 +13122,7 @@ paths: author: *4 assets: type: array - items: &608 + items: &610 title: Release Asset description: Data related to a release. type: object @@ -12934,7 +13197,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *84 + reactions: *86 required: - assets_url - upload_url @@ -13026,7 +13289,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': &120 + '503': &122 description: Service unavailable content: application/json: @@ -13119,7 +13382,7 @@ paths: _links: type: object properties: - timeline: &92 + timeline: &94 title: Link With Type description: Hypermedia Link with Type type: object @@ -13131,17 +13394,17 @@ paths: required: - href - type - user: *92 - security_advisories: *92 - current_user: *92 - current_user_public: *92 - current_user_actor: *92 - current_user_organization: *92 + user: *94 + security_advisories: *94 + current_user: *94 + current_user_public: *94 + current_user_actor: *94 + current_user_organization: *94 current_user_organizations: type: array - items: *92 - repository_discussions: *92 - repository_discussions_category: *92 + items: *94 + repository_discussions: *94 + repository_discussions_category: *94 required: - timeline - user @@ -13203,7 +13466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *93 + - *95 - *17 - *19 responses: @@ -13213,7 +13476,7 @@ paths: application/json: schema: type: array - items: &94 + items: &96 title: Base Gist description: Base Gist type: object @@ -13298,7 +13561,7 @@ paths: - created_at - updated_at examples: - default: &95 + default: &97 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -13343,7 +13606,7 @@ paths: site_admin: false truncated: false headers: - Link: *68 + Link: *70 '304': *37 '403': *29 x-github: @@ -13419,7 +13682,7 @@ paths: description: Response content: application/json: - schema: &96 + schema: &98 title: Gist Simple description: Gist Simple type: object @@ -13587,7 +13850,7 @@ paths: truncated: type: boolean examples: - default: &97 + default: &99 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -13691,7 +13954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *93 + - *95 - *17 - *19 responses: @@ -13701,11 +13964,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '403': *29 @@ -13725,7 +13988,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *93 + - *95 - *17 - *19 responses: @@ -13735,11 +13998,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '401': *25 '304': *37 '403': *29 @@ -13764,7 +14027,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &98 + - &100 name: gist_id description: The unique identifier of the gist. in: path @@ -13776,10 +14039,10 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - default: *97 - '403': &101 + default: *99 + '403': &103 description: Forbidden Gist content: application/json: @@ -13826,7 +14089,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *98 + - *100 requestBody: required: true content: @@ -13886,9 +14149,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - updateGist: *97 + updateGist: *99 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -14046,7 +14309,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -14074,7 +14337,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *98 + - *100 - *17 - *19 responses: @@ -14084,7 +14347,7 @@ paths: application/json: schema: type: array - items: &99 + items: &101 title: Gist Comment description: A comment made to a gist. type: object @@ -14119,7 +14382,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *83 + author_association: *85 required: - url - id @@ -14159,7 +14422,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -14183,7 +14446,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *98 + - *100 requestBody: required: true content: @@ -14208,9 +14471,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: &100 + default: &102 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -14267,8 +14530,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *98 - - &102 + - *100 + - &104 name: comment_id description: The unique identifier of the comment. in: path @@ -14281,12 +14544,12 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: *100 + default: *102 '304': *37 '404': *6 - '403': *101 + '403': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14307,8 +14570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *98 - - *102 + - *100 + - *104 requestBody: required: true content: @@ -14333,9 +14596,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: *100 + default: *102 '404': *6 x-github: githubCloudOnly: false @@ -14352,8 +14615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *98 - - *102 + - *100 + - *104 responses: '204': description: Response @@ -14376,7 +14639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *98 + - *100 - *17 - *19 responses: @@ -14477,7 +14740,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *98 + - *100 - *17 - *19 responses: @@ -14487,7 +14750,7 @@ paths: application/json: schema: type: array - items: *96 + items: *98 examples: default: value: @@ -14533,7 +14796,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 '304': *37 '403': *29 @@ -14552,13 +14815,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *98 + - *100 responses: '201': description: Response content: application/json: - schema: *94 + schema: *96 examples: default: value: @@ -14628,7 +14891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *98 + - *100 responses: '204': description: Response if gist is starred @@ -14658,7 +14921,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -14680,7 +14943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -14708,7 +14971,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *98 + - *100 - name: sha in: path required: true @@ -14719,9 +14982,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - default: *97 + default: *99 '422': *15 '404': *6 '403': *29 @@ -14882,7 +15145,7 @@ paths: type: array items: allOf: - - *80 + - *82 repository_selection: type: string example: selected @@ -15005,7 +15268,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '403': *29 '304': *37 '401': *25 @@ -15089,7 +15352,7 @@ paths: - closed - all default: open - - &245 + - &247 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15108,7 +15371,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - name: collab in: query required: false @@ -15138,9 +15401,9 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: &246 + default: &248 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15385,7 +15648,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '404': *6 @@ -15424,8 +15687,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 examples: default: value: @@ -15710,7 +15973,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &103 + X-CommonMarker-Version: &105 example: 0.17.4 schema: type: string @@ -15765,7 +16028,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *103 + X-CommonMarker-Version: *105 content: text/html: schema: @@ -15794,7 +16057,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &106 + - &108 name: account_id description: account_id parameter in: path @@ -15806,7 +16069,7 @@ paths: description: Response content: application/json: - schema: &105 + schema: &107 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -15836,7 +16099,7 @@ paths: nullable: true id: type: integer - plan: &104 + plan: &106 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -15925,7 +16188,7 @@ paths: nullable: true updated_at: type: string - plan: *104 + plan: *106 required: - url - id @@ -15933,7 +16196,7 @@ paths: - login - marketplace_purchase examples: - default: &107 + default: &109 value: url: https://api.github.com/orgs/github type: Organization @@ -16018,9 +16281,9 @@ paths: application/json: schema: type: array - items: *104 + items: *106 examples: - default: &108 + default: &110 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -16038,7 +16301,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '404': *6 '401': *25 x-github: @@ -16060,14 +16323,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &109 + - &111 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &110 + - &112 name: sort description: The property to sort the results by. in: query @@ -16097,9 +16360,9 @@ paths: application/json: schema: type: array - items: *105 + items: *107 examples: - default: &111 + default: &113 value: - url: https://api.github.com/orgs/github type: Organization @@ -16150,7 +16413,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '404': *6 '422': *15 '401': *25 @@ -16173,15 +16436,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *106 + - *108 responses: '200': description: Response content: application/json: - schema: *105 + schema: *107 examples: - default: *107 + default: *109 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -16213,11 +16476,11 @@ paths: application/json: schema: type: array - items: *104 + items: *106 examples: - default: *108 + default: *110 headers: - Link: *68 + Link: *70 '401': *25 x-github: githubCloudOnly: false @@ -16238,8 +16501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *109 - - *110 + - *111 + - *112 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -16259,11 +16522,11 @@ paths: application/json: schema: type: array - items: *105 + items: *107 examples: - default: *111 + default: *113 headers: - Link: *68 + Link: *70 '401': *25 x-github: githubCloudOnly: false @@ -16525,14 +16788,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &342 + - &344 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &343 + - &345 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16549,7 +16812,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -16594,7 +16857,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &346 + '301': &348 description: Moved permanently content: application/json: @@ -16616,7 +16879,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &583 + - &585 name: all description: If `true`, show notifications marked as read. in: query @@ -16624,7 +16887,7 @@ paths: schema: type: boolean default: false - - &584 + - &586 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16633,8 +16896,8 @@ paths: schema: type: boolean default: false - - *93 - - &585 + - *95 + - &587 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -16659,18 +16922,18 @@ paths: application/json: schema: type: array - items: &113 + items: &115 title: Thread description: Thread type: object properties: id: type: string - repository: &159 + repository: &161 title: Minimal Repository description: Minimal Repository type: object - properties: &211 + properties: &213 id: type: integer format: int64 @@ -16954,7 +17217,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &297 + security_and_analysis: &299 nullable: true type: object properties: @@ -17074,7 +17337,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &212 + required: &214 - archive_url - assignees_url - blobs_url @@ -17162,7 +17425,7 @@ paths: - url - subscription_url examples: - default: &586 + default: &588 value: - id: '1' repository: @@ -17244,7 +17507,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -17328,7 +17591,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &114 + - &116 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -17342,7 +17605,7 @@ paths: description: Response content: application/json: - schema: *113 + schema: *115 examples: default: value: @@ -17444,7 +17707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *114 + - *116 responses: '205': description: Reset Content @@ -17466,7 +17729,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *114 + - *116 responses: '204': description: No content @@ -17489,13 +17752,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *114 + - *116 responses: '200': description: Response content: application/json: - schema: &115 + schema: &117 title: Thread Subscription description: Thread Subscription type: object @@ -17532,7 +17795,7 @@ paths: - url - subscribed examples: - default: &116 + default: &118 value: subscribed: true ignored: false @@ -17563,7 +17826,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *114 + - *116 requestBody: required: false content: @@ -17584,9 +17847,9 @@ paths: description: Response content: application/json: - schema: *115 + schema: *117 examples: - default: *116 + default: *118 '304': *37 '403': *29 '401': *25 @@ -17609,7 +17872,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *114 + - *116 responses: '204': description: Response @@ -17704,9 +17967,9 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: Link: example: ; rel="next" @@ -17733,13 +17996,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &118 + schema: &120 title: Actions cache retention limit for an organization description: GitHub Actions cache retention policy for an organization. type: object @@ -17772,12 +18035,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *118 + schema: *120 examples: selected_actions: *42 responses: @@ -17806,13 +18069,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &119 + schema: &121 title: Actions cache storage limit for an organization description: GitHub Actions cache storage policy for an organization. type: object @@ -17845,12 +18108,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *119 + schema: *121 examples: selected_actions: *44 responses: @@ -17880,7 +18143,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - - *76 + - *78 - name: page description: The page number of the results to fetch. in: query @@ -18052,8 +18315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization parameters: - - *76 - - &121 + - *78 + - &123 name: budget_id description: The ID corresponding to the budget. in: path @@ -18150,7 +18413,7 @@ paths: '404': *6 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18170,8 +18433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization parameters: - - *76 - - *121 + - *78 + - *123 requestBody: required: true content: @@ -18362,8 +18625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization parameters: - - *76 - - *121 + - *78 + - *123 responses: '200': description: Response when deleting a budget @@ -18390,7 +18653,7 @@ paths: '404': *6 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18410,8 +18673,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization parameters: - - *76 - - &122 + - *78 + - &124 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -18420,7 +18683,7 @@ paths: required: false schema: type: integer - - &124 + - &126 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current @@ -18429,7 +18692,7 @@ paths: required: false schema: type: integer - - &123 + - &125 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -18444,14 +18707,14 @@ paths: required: false schema: type: string - - &733 + - &735 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &125 + - &127 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -18568,7 +18831,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18588,9 +18851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - - *76 - - *122 - - &734 + - *78 + - *124 + - &736 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -18599,7 +18862,7 @@ paths: required: false schema: type: integer - - *123 + - *125 responses: '200': description: Billing usage report response for an organization @@ -18675,7 +18938,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18698,19 +18961,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization parameters: - - *76 - - *122 + - *78 - *124 - - *123 - - &735 + - *126 + - *125 + - &737 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *125 - - &736 + - *127 + - &738 name: sku description: The SKU to query for usage. in: query @@ -18821,7 +19084,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18847,13 +19110,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &126 + schema: &128 title: Organization Full description: Organization Full type: object @@ -19167,7 +19430,7 @@ paths: - updated_at - archived_at examples: - default-response: &127 + default-response: &129 value: login: github id: 1 @@ -19266,7 +19529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *76 + - *78 requestBody: required: false content: @@ -19478,17 +19741,17 @@ paths: description: Response content: application/json: - schema: *126 + schema: *128 examples: - default: *127 + default: *129 '422': description: Validation failed content: application/json: schema: oneOf: - - *128 - - *129 + - *130 + - *131 '409': *54 x-github: githubCloudOnly: false @@ -19512,7 +19775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *76 + - *78 responses: '202': *39 '404': *6 @@ -19538,7 +19801,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -19564,7 +19827,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19585,7 +19848,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -19603,7 +19866,7 @@ paths: type: integer repository_cache_usages: type: array - items: &353 + items: &355 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19638,7 +19901,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19658,7 +19921,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -19676,7 +19939,7 @@ paths: type: integer runners: type: array - items: &130 + items: &132 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -19730,7 +19993,7 @@ paths: - display_name - source nullable: true - machine_size_details: &138 + machine_size_details: &140 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -19826,7 +20089,7 @@ paths: - public_ip_enabled - platform examples: - default: &158 + default: &160 value: total_count: 2 runners: @@ -19868,7 +20131,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19886,7 +20149,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -19963,9 +20226,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: &139 + default: &141 value: id: 5 name: My hosted ubuntu runner @@ -20006,7 +20269,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20022,7 +20285,7 @@ paths: type: integer images: type: array - items: &131 + items: &133 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -20073,7 +20336,7 @@ paths: - latest_version - state examples: - default: &133 + default: &135 value: total_count: 2 image_versions: @@ -20104,8 +20367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - - *76 - - &132 + - *78 + - &134 name: image_definition_id description: Image definition ID of custom image in: path @@ -20117,7 +20380,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *133 examples: default: value: @@ -20147,8 +20410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *76 - - *132 + - *78 + - *134 responses: '204': description: Response @@ -20171,8 +20434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - - *132 - - *76 + - *134 + - *78 responses: '200': description: Response @@ -20188,7 +20451,7 @@ paths: type: integer image_versions: type: array - items: &134 + items: &136 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -20221,7 +20484,7 @@ paths: - created_on - state_details examples: - default: *133 + default: *135 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20241,9 +20504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - - *76 - - *132 - - &135 + - *78 + - *134 + - &137 name: version description: Version of a custom image in: path @@ -20256,7 +20519,7 @@ paths: description: Response content: application/json: - schema: *134 + schema: *136 examples: default: value: @@ -20282,9 +20545,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - - *76 - - *132 - - *135 + - *78 + - *134 + - *137 responses: '204': description: Response @@ -20305,7 +20568,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20321,7 +20584,7 @@ paths: type: integer images: type: array - items: &136 + items: &138 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -20357,7 +20620,7 @@ paths: - display_name - source examples: - default: &137 + default: &139 value: id: ubuntu-20.04 platform: linux-x64 @@ -20381,7 +20644,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20397,9 +20660,9 @@ paths: type: integer images: type: array - items: *136 + items: *138 examples: - default: *137 + default: *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20416,7 +20679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20469,7 +20732,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20485,7 +20748,7 @@ paths: type: integer machine_specs: type: array - items: *138 + items: *140 examples: default: value: @@ -20510,7 +20773,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20554,8 +20817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *76 - - &140 + - *78 + - &142 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -20567,11 +20830,11 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20589,8 +20852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *76 - - *140 + - *78 + - *142 requestBody: required: true content: @@ -20656,9 +20919,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20674,16 +20937,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *76 - - *140 + - *78 + - *142 responses: '202': description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -20703,7 +20966,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: A JSON array of OIDC custom property inclusions @@ -20736,12 +20999,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *141 + schema: *143 examples: default: *46 responses: @@ -20775,7 +21038,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization parameters: - - *76 + - *78 - name: custom_property_name in: path required: true @@ -20808,7 +21071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *76 + - *78 responses: '200': description: A JSON serialized template for OIDC subject claim customization @@ -20825,10 +21088,16 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the + name-based format. + type: boolean required: - include_claim_keys examples: - default: &142 + default: &144 value: include_claim_keys: - repo @@ -20850,7 +21119,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -20866,14 +21135,20 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: - default: *142 + default: *144 responses: '201': description: Empty response content: application/json: - schema: &168 + schema: &170 title: Empty Object description: An object without any properties. type: object @@ -20903,7 +21178,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20912,7 +21187,7 @@ paths: schema: type: object properties: - enabled_repositories: &143 + enabled_repositories: &145 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -20925,7 +21200,7 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: &144 + allowed_actions: &146 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -20933,12 +21208,12 @@ paths: - all - local_only - selected - selected_actions_url: &359 + selected_actions_url: &361 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &145 + sha_pinning_required: &147 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -20969,7 +21244,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -20980,9 +21255,9 @@ paths: schema: type: object properties: - enabled_repositories: *143 - allowed_actions: *144 - sha_pinning_required: *145 + enabled_repositories: *145 + allowed_actions: *146 + sha_pinning_required: *147 required: - enabled_repositories examples: @@ -21010,13 +21285,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &363 + schema: &365 type: object properties: days: @@ -21053,12 +21328,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &364 + schema: &366 type: object properties: days: @@ -21095,13 +21370,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &146 + schema: &148 type: object properties: approval_policy: @@ -21115,7 +21390,7 @@ paths: required: - approval_policy examples: - default: &365 + default: &367 value: approval_policy: first_time_contributors '404': *6 @@ -21136,7 +21411,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21146,7 +21421,7 @@ paths: required: true content: application/json: - schema: *146 + schema: *148 examples: default: summary: Set approval policy to first time contributors @@ -21168,13 +21443,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &366 + schema: &368 type: object required: - run_workflows_from_fork_pull_requests @@ -21200,7 +21475,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &147 + default: &149 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -21223,12 +21498,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &367 + schema: &369 type: object required: - run_workflows_from_fork_pull_requests @@ -21251,7 +21526,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *147 + default: *149 responses: '204': description: Empty response for successful settings update @@ -21281,7 +21556,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -21299,9 +21574,9 @@ paths: type: number repositories: type: array - items: *80 + items: *82 examples: - default: &151 + default: &153 value: total_count: 1 repositories: @@ -21441,7 +21716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21485,8 +21760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *76 - - &148 + - *78 + - &150 name: repository_id description: The unique identifier of the repository. in: path @@ -21514,8 +21789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -21538,13 +21813,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &149 + schema: &151 type: object properties: github_owned_allowed: @@ -21566,7 +21841,7 @@ paths: items: type: string examples: - default: &150 + default: &152 value: github_owned_allowed: true verified_allowed: false @@ -21591,7 +21866,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21599,9 +21874,9 @@ paths: required: false content: application/json: - schema: *149 + schema: *151 examples: - selected_actions: *150 + selected_actions: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21621,7 +21896,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -21669,7 +21944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -21716,7 +21991,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -21731,9 +22006,9 @@ paths: type: integer repositories: type: array - items: *80 + items: *82 examples: - default: *151 + default: *153 '403': *29 '404': *6 x-github: @@ -21753,7 +22028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -21801,8 +22076,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No content @@ -21828,8 +22103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No content @@ -21857,23 +22132,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &368 + schema: &370 type: object properties: - default_workflow_permissions: &152 + default_workflow_permissions: &154 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &153 + can_approve_pull_request_reviews: &155 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -21881,7 +22156,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &154 + default: &156 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -21906,7 +22181,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Success response @@ -21914,13 +22189,13 @@ paths: required: false content: application/json: - schema: &369 + schema: &371 type: object properties: - default_workflow_permissions: *152 - can_approve_pull_request_reviews: *153 + default_workflow_permissions: *154 + can_approve_pull_request_reviews: *155 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21940,7 +22215,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *76 + - *78 - *17 - *19 - name: visible_to_repository @@ -21965,7 +22240,7 @@ paths: type: number runner_groups: type: array - items: &155 + items: &157 type: object properties: id: @@ -22081,7 +22356,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -22153,9 +22428,9 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: - default: &157 + default: &159 value: id: 2 name: octo-runner-group @@ -22190,8 +22465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *76 - - &156 + - *78 + - &158 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -22203,7 +22478,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: default: value: @@ -22239,8 +22514,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -22294,9 +22569,9 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: - default: *157 + default: *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22315,8 +22590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *76 - - *156 + - *78 + - *158 responses: '204': description: Response @@ -22339,8 +22614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *17 - *19 responses: @@ -22358,11 +22633,11 @@ paths: type: number runners: type: array - items: *130 + items: *132 examples: - default: *158 + default: *160 headers: - Link: *68 + Link: *70 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22382,8 +22657,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *19 - *17 responses: @@ -22401,9 +22676,9 @@ paths: type: number repositories: type: array - items: *159 + items: *161 examples: - default: &196 + default: &198 value: total_count: 1 repositories: @@ -22655,8 +22930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -22700,9 +22975,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 - - *148 + - *78 + - *158 + - *150 responses: '204': description: Response @@ -22724,9 +22999,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 - - *148 + - *78 + - *158 + - *150 responses: '204': description: Response @@ -22749,8 +23024,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *17 - *19 responses: @@ -22768,7 +23043,7 @@ paths: type: number runners: type: array - items: &161 + items: &163 title: Self hosted runners description: A self hosted runner type: object @@ -22797,7 +23072,7 @@ paths: type: boolean labels: type: array - items: &164 + items: &166 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -22827,7 +23102,7 @@ paths: - busy - labels examples: - default: &162 + default: &164 value: total_count: 2 runners: @@ -22867,7 +23142,7 @@ paths: name: no-gpu type: custom headers: - Link: *68 + Link: *70 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22886,8 +23161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -22931,9 +23206,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *76 - - *156 - - &160 + - *78 + - *158 + - &162 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -22961,9 +23236,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *76 - - *156 - - *160 + - *78 + - *158 + - *162 responses: '204': description: Response @@ -22993,7 +23268,7 @@ paths: in: query schema: type: string - - *76 + - *78 - *17 - *19 responses: @@ -23011,11 +23286,11 @@ paths: type: integer runners: type: array - items: *161 + items: *163 examples: - default: *162 + default: *164 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23037,7 +23312,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -23045,7 +23320,7 @@ paths: application/json: schema: type: array - items: &370 + items: &372 title: Runner Application description: Runner Application type: object @@ -23070,7 +23345,7 @@ paths: - download_url - filename examples: - default: &371 + default: &373 value: - os: osx architecture: x64 @@ -23113,7 +23388,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -23156,7 +23431,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &372 + '201': &374 description: Response content: application/json: @@ -23166,7 +23441,7 @@ paths: - runner - encoded_jit_config properties: - runner: *161 + runner: *163 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -23223,13 +23498,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *76 + - *78 responses: '201': description: Response content: application/json: - schema: &163 + schema: &165 title: Authentication Token description: Authentication Token type: object @@ -23251,7 +23526,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *80 + items: *82 single_file: type: string example: config.yaml @@ -23267,7 +23542,7 @@ paths: - token - expires_at examples: - default: &373 + default: &375 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23298,15 +23573,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *76 + - *78 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: &374 + default: &376 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23331,16 +23606,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: '200': description: Response content: application/json: - schema: *161 + schema: *163 examples: - default: &375 + default: &377 value: id: 23 name: MBP @@ -23381,8 +23656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: '204': description: Response @@ -23408,10 +23683,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: - '200': &165 + '200': &167 description: Response content: application/json: @@ -23425,7 +23700,7 @@ paths: type: integer labels: type: array - items: *164 + items: *166 examples: default: value: @@ -23464,8 +23739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 requestBody: required: true content: @@ -23489,7 +23764,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -23513,8 +23788,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 requestBody: required: true content: @@ -23539,7 +23814,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -23563,10 +23838,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: - '200': &376 + '200': &378 description: Response content: application/json: @@ -23580,7 +23855,7 @@ paths: type: integer labels: type: array - items: *164 + items: *166 examples: default: value: @@ -23621,9 +23896,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 - - &377 + - *78 + - *162 + - &379 name: name description: The name of a self-hosted runner's custom label. in: path @@ -23631,7 +23906,7 @@ paths: schema: type: string responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -23656,7 +23931,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -23674,7 +23949,7 @@ paths: type: integer secrets: type: array - items: &166 + items: &168 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -23724,7 +23999,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23747,13 +24022,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &389 + schema: &391 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23782,7 +24057,7 @@ paths: - key_id - key examples: - default: &390 + default: &392 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23807,8 +24082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *76 - - &167 + - *78 + - &169 name: secret_name description: The name of the secret. in: path @@ -23820,7 +24095,7 @@ paths: description: Response content: application/json: - schema: *166 + schema: *168 examples: default: value: @@ -23850,8 +24125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -23908,7 +24183,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -23934,8 +24209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -23961,8 +24236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -23980,9 +24255,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: &171 + default: &173 value: total_count: 1 repositories: @@ -24074,8 +24349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -24127,8 +24402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -24161,8 +24436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -24194,8 +24469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *76 - - &358 + - *78 + - &360 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -24219,7 +24494,7 @@ paths: type: integer variables: type: array - items: &169 + items: &171 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -24283,7 +24558,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24304,7 +24579,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *76 + - *78 requestBody: required: true content: @@ -24352,7 +24627,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -24377,8 +24652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *76 - - &170 + - *78 + - &172 name: name description: The name of the variable. in: path @@ -24390,7 +24665,7 @@ paths: description: Response content: application/json: - schema: *169 + schema: *171 examples: default: value: @@ -24420,8 +24695,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 requestBody: required: true content: @@ -24483,8 +24758,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 responses: '204': description: Response @@ -24510,8 +24785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - *19 - *17 responses: @@ -24529,9 +24804,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24557,8 +24832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 requestBody: required: true content: @@ -24607,8 +24882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - name: repository_id in: path required: true @@ -24642,8 +24917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - name: repository_id in: path required: true @@ -24684,7 +24959,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *76 + - *78 requestBody: required: true content: @@ -24807,7 +25082,7 @@ paths: type: integer deployment_records: type: array - items: &172 + items: &174 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -24853,7 +25128,7 @@ paths: required: - total_count examples: - default: &173 + default: &175 value: total_count: 1 deployment_records: @@ -24890,7 +25165,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *76 + - *78 - name: cluster in: path description: The cluster name. @@ -25033,11 +25308,11 @@ paths: type: integer deployment_records: type: array - items: *172 + items: *174 required: - total_count examples: - default: *173 + default: *175 '403': description: Forbidden content: @@ -25084,7 +25359,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *76 + - *78 requestBody: required: true content: @@ -25247,7 +25522,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *76 + - *78 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -25272,9 +25547,9 @@ paths: type: integer deployment_records: type: array - items: *172 + items: *174 examples: - default: *173 + default: *175 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25294,7 +25569,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *76 + - *78 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -25379,7 +25654,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 requestBody: required: true content: @@ -25403,12 +25678,12 @@ paths: required: - subject_digests examples: - default: &715 + default: &717 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &716 + withPredicateType: &718 value: subject_digests: - sha256:abc123 @@ -25452,7 +25727,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &717 + default: &719 value: attestations_subject_digests: - sha256:abc: @@ -25561,7 +25836,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *76 + - *78 requestBody: required: true content: @@ -25626,7 +25901,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *76 + - *78 - name: subject_digest description: Subject Digest in: path @@ -25661,7 +25936,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -25709,7 +25984,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *76 + - *78 - name: attestation_id description: Attestation ID in: path @@ -25747,7 +26022,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -25785,7 +26060,7 @@ paths: initiator: type: string examples: - default: &403 + default: &405 value: attestations: - bundle: @@ -25892,7 +26167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -25904,7 +26179,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25923,8 +26198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: If the user is blocked @@ -25949,8 +26224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -25970,8 +26245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -25996,7 +26271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *76 + - *78 - *19 - *17 - *62 @@ -26004,7 +26279,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &174 + schema: &176 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -26030,7 +26305,7 @@ paths: application/json: schema: type: array - items: &175 + items: &177 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -26061,7 +26336,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &195 + items: &197 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -26136,7 +26411,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &257 + properties: &259 id: description: Unique identifier of the team type: integer @@ -26208,7 +26483,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &258 + required: &260 - id - node_id - url @@ -26251,7 +26526,7 @@ paths: type: string format: date-time nullable: true - state: *174 + state: *176 contact_link: description: The contact link of the campaign. type: string @@ -26346,9 +26621,9 @@ paths: closed_at: state: open headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26372,7 +26647,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -26471,9 +26746,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: &176 + default: &178 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -26522,7 +26797,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26544,7 +26819,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -26556,16 +26831,16 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: *176 + default: *178 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26586,7 +26861,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -26635,7 +26910,7 @@ paths: type: string format: uri nullable: true - state: *174 + state: *176 examples: default: value: @@ -26645,9 +26920,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: *176 + default: *178 '400': description: Bad Request content: @@ -26659,7 +26934,7 @@ paths: content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26680,7 +26955,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -26691,7 +26966,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26713,18 +26988,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *76 - - &428 + - *78 + - &430 name: tool_name 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. in: query required: false - schema: &184 + schema: &186 type: string description: The name of the tool used to generate the code scanning analysis. - - &429 + - &431 name: tool_guid 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 @@ -26732,7 +27007,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &185 + schema: &187 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -26747,7 +27022,7 @@ paths: be returned. in: query required: false - schema: &431 + schema: &433 type: string description: State of a code scanning alert. enum: @@ -26770,7 +27045,7 @@ paths: be returned. in: query required: false - schema: &432 + schema: &434 type: string description: Severity of a code scanning alert. enum: @@ -26799,18 +27074,18 @@ paths: items: type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: &433 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: &435 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &186 + state: &188 type: string description: State of a code scanning alert. nullable: true @@ -26818,7 +27093,7 @@ paths: - open - dismissed - fixed - fixed_at: *182 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -26826,8 +27101,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: &434 + dismissed_at: *185 + dismissed_reason: &436 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -26836,13 +27111,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &435 + dismissed_comment: &437 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &436 + rule: &438 type: object properties: id: @@ -26895,42 +27170,42 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &437 + tool: &439 type: object properties: - name: *184 + name: *186 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *185 - most_recent_instance: &438 + guid: *187 + most_recent_instance: &440 type: object properties: - ref: &430 + ref: &432 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &448 + analysis_key: &450 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &449 + environment: &451 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &450 + category: &452 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *186 + state: *188 commit_sha: type: string message: @@ -26944,7 +27219,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &451 + location: &453 type: object description: Describe a region within a file for the alert. properties: @@ -26965,7 +27240,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &452 + items: &454 type: string description: A classification of the file. For example to identify it as generated. @@ -27230,9 +27505,9 @@ paths: trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27254,7 +27529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *76 + - *78 - name: target_type in: query description: The target type of the code security configuration @@ -27360,7 +27635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *76 + - *78 requestBody: required: true content: @@ -27604,7 +27879,7 @@ paths: application/json: schema: *49 examples: - default: *187 + default: *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27626,15 +27901,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *188 + schema: *190 examples: - default: *189 + default: *191 '304': *37 '403': *29 '404': *6 @@ -27660,7 +27935,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *76 + - *78 requestBody: required: true content: @@ -27668,6 +27943,8 @@ paths: schema: type: object additionalProperties: false + required: + - selected_repository_ids properties: selected_repository_ids: type: array @@ -27712,7 +27989,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *76 + - *78 - *51 responses: '200': @@ -27721,7 +27998,7 @@ paths: application/json: schema: *49 examples: - default: *187 + default: *189 '304': *37 '403': *29 '404': *6 @@ -27745,7 +28022,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28025,7 +28302,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *76 + - *78 - *51 responses: '204': *61 @@ -28056,7 +28333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28120,7 +28397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28166,7 +28443,7 @@ paths: default: value: default_for_new_repos: all - configuration: *187 + configuration: *189 '403': *29 '404': *6 x-github: @@ -28190,7 +28467,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *76 + - *78 - *51 - name: per_page description: The number of results per page (max 100). For more information, @@ -28219,13 +28496,13 @@ paths: application/json: schema: type: array - items: *190 + items: *192 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *191 + repository: *193 '403': *29 '404': *6 x-github: @@ -28249,7 +28526,7 @@ paths: parameters: - *17 - *19 - - *76 + - *78 responses: '200': description: Response @@ -28265,7 +28542,7 @@ paths: type: integer codespaces: type: array - items: &247 + items: &249 type: object title: Codespace description: A codespace. @@ -28290,12 +28567,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *159 + repository: *161 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &464 + properties: &466 name: type: string description: The name of the machine. @@ -28337,7 +28614,7 @@ paths: - ready - in_progress nullable: true - required: &465 + required: &467 - name - display_name - operating_system @@ -28542,7 +28819,7 @@ paths: - pulls_url - recent_folders examples: - default: &248 + default: &250 value: total_count: 3 codespaces: @@ -28974,7 +29251,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *76 + - *78 deprecated: true requestBody: required: true @@ -29041,7 +29318,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *76 + - *78 deprecated: true requestBody: required: true @@ -29096,7 +29373,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *76 + - *78 requestBody: required: true content: @@ -29148,7 +29425,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -29166,7 +29443,7 @@ paths: type: integer secrets: type: array - items: &192 + items: &194 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -29205,7 +29482,7 @@ paths: - updated_at - visibility examples: - default: &466 + default: &468 value: total_count: 2 secrets: @@ -29218,7 +29495,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -29237,13 +29514,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &467 + schema: &469 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -29272,7 +29549,7 @@ paths: - key_id - key examples: - default: &468 + default: &470 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29295,23 +29572,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: Response content: application/json: - schema: *192 + schema: *194 examples: - default: &470 + default: &472 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -29331,8 +29608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -29387,7 +29664,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -29413,8 +29690,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -29439,8 +29716,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -29458,9 +29735,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 '404': *6 x-github: githubCloudOnly: false @@ -29482,8 +29759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -29533,8 +29810,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -29567,8 +29844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -29607,7 +29884,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: OK @@ -29748,7 +30025,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *76 + - *78 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -29771,7 +30048,7 @@ paths: currently being billed. seats: type: array - items: &250 + items: &252 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -29788,15 +30065,15 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *193 - required: *194 + properties: *195 + required: *196 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *195 - - *69 + - *197 + - *71 nullable: true pending_cancellation_date: type: string @@ -29920,7 +30197,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '500': *55 '401': *25 '403': *29 @@ -29954,7 +30231,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30032,7 +30309,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30112,7 +30389,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30189,7 +30466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30267,7 +30544,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -30332,7 +30609,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -30387,7 +30664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -30402,12 +30679,12 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 required: - total_count - repositories examples: - default: *196 + default: *198 '500': *55 '401': *25 '403': *29 @@ -30436,7 +30713,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -30492,8 +30769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No Content @@ -30526,8 +30803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No Content @@ -30566,7 +30843,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization parameters: - - *76 + - *78 responses: '200': description: OK @@ -30619,7 +30896,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization parameters: - - *76 + - *78 requestBody: description: The content exclusion rules to set required: true @@ -30710,7 +30987,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *76 + - *78 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -30742,7 +31019,7 @@ paths: application/json: schema: type: array - items: &335 + items: &337 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -31049,7 +31326,7 @@ paths: - date additionalProperties: true examples: - default: &336 + default: &338 value: - date: '2024-06-24' total_active_users: 24 @@ -31151,7 +31428,7 @@ paths: '500': *55 '403': *29 '404': *6 - '422': &337 + '422': &339 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -31182,7 +31459,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day parameters: - - *76 + - *78 - *56 responses: '200': @@ -31221,7 +31498,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics parameters: - - *76 + - *78 responses: '200': description: Response @@ -31258,7 +31535,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day parameters: - - *76 + - *78 - *56 responses: '200': @@ -31297,7 +31574,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics parameters: - - *76 + - *78 responses: '200': description: Response @@ -31330,13 +31607,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *76 - - *197 - - *198 + - *78 - *199 - *200 - *201 - *202 + - *203 + - *204 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -31366,7 +31643,7 @@ paths: enum: - patch - deployment - - *203 + - *205 - name: runtime_risk in: query description: |- @@ -31375,8 +31652,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *204 - - *205 + - *206 + - *207 - *62 - *47 - *48 @@ -31388,9 +31665,9 @@ paths: application/json: schema: type: array - items: *206 + items: *208 examples: - default: *207 + default: *209 '304': *37 '400': *14 '403': *29 @@ -31416,7 +31693,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *76 + - *78 - name: page in: query description: The page number of results to fetch. @@ -31439,104 +31716,9 @@ paths: description: Response content: application/json: - schema: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able - to access in an organization - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot - updates. - enum: - - public - - internal - example: internal - nullable: true - accessible_repositories: - type: array - items: - title: Simple Repository - description: A GitHub repository. - type: object - properties: *208 - required: *209 - nullable: true - additionalProperties: false + schema: *210 examples: - default: - value: - default_level: public - accessible_repositories: - - id: 123456 - node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= - name: example-repo - full_name: octocat/example-repo - owner: - name: octocat - email: octo@github.com - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://avatars.githubusercontent.com/u/1?v=4 - gravatar_id: 1 - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat/example-repo - 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 - starred_at: '"2020-07-09T00:17:55Z"' - user_view_type: default - private: false - html_url: https://github.com/octocat/example-repo - description: This is an example repository. - fork: false - url: https://api.github.com/repos/octocat/example-repo - archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} - commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} - compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/example-repo/contributors - deployments_url: https://api.github.com/repos/octocat/example-repo/deployments - downloads_url: https://api.github.com/repos/octocat/example-repo/downloads - events_url: https://api.github.com/repos/octocat/example-repo/events - forks_url: https://api.github.com/repos/octocat/example-repo/forks - git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} - keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} - languages_url: https://api.github.com/repos/octocat/example-repo/languages - merges_url: https://api.github.com/repos/octocat/example-repo/merges - milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} - releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers - statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/example-repo/subscription - tags_url: https://api.github.com/repos/octocat/example-repo/tags - teams_url: https://api.github.com/repos/octocat/example-repo/teams - trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + default: *211 '403': *29 '404': *6 x-github: @@ -31567,7 +31749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -31633,7 +31815,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *76 + - *78 requestBody: required: true content: @@ -31681,7 +31863,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -31699,7 +31881,7 @@ paths: type: integer secrets: type: array - items: &210 + items: &212 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -31749,7 +31931,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31770,13 +31952,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &501 + schema: &503 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -31793,7 +31975,7 @@ paths: - key_id - key examples: - default: &502 + default: &504 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -31816,14 +31998,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: Response content: application/json: - schema: *210 + schema: *212 examples: default: value: @@ -31851,8 +32033,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -31907,7 +32089,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -31931,8 +32113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -31956,8 +32138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -31975,9 +32157,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31998,8 +32180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -32049,8 +32231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -32081,8 +32263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -32112,7 +32294,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -32120,7 +32302,7 @@ paths: application/json: schema: type: array - items: &260 + items: &262 title: Package description: A software package type: object @@ -32170,8 +32352,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *211 - required: *212 + properties: *213 + required: *214 nullable: true created_at: type: string @@ -32190,7 +32372,7 @@ paths: - created_at - updated_at examples: - default: &261 + default: &263 value: - id: 197 name: hello_docker @@ -32268,7 +32450,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32278,7 +32460,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: 200-response: value: @@ -32350,7 +32532,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32360,7 +32542,7 @@ paths: application/json: schema: type: array - items: &236 + items: &238 title: Organization Invitation description: Organization Invitation type: object @@ -32407,7 +32589,7 @@ paths: - invitation_teams_url - node_id examples: - default: &237 + default: &239 value: - id: 1 login: monalisa @@ -32440,7 +32622,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -32464,7 +32646,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32474,7 +32656,7 @@ paths: application/json: schema: type: array - items: &213 + items: &215 title: Org Hook description: Org Hook type: object @@ -32562,7 +32744,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -32585,7 +32767,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *76 + - *78 requestBody: required: true content: @@ -32645,9 +32827,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *215 examples: - default: &214 + default: &216 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -32694,8 +32876,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *76 - - &215 + - *78 + - &217 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -32708,9 +32890,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *215 examples: - default: *214 + default: *216 '404': *6 x-github: githubCloudOnly: false @@ -32737,8 +32919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 requestBody: required: false content: @@ -32783,7 +32965,7 @@ paths: description: Response content: application/json: - schema: *213 + schema: *215 examples: default: value: @@ -32824,8 +33006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 responses: '204': description: Response @@ -32852,8 +33034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *76 - - *215 + - *78 + - *217 responses: '200': description: Response @@ -32883,8 +33065,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *76 - - *215 + - *78 + - *217 requestBody: required: false content: @@ -32934,11 +33116,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *76 - - *215 - - *17 - - *216 + - *78 - *217 + - *17 + - *218 + - *219 responses: '200': description: Response @@ -32946,9 +33128,9 @@ paths: application/json: schema: type: array - items: *218 + items: *220 examples: - default: *219 + default: *221 '400': *14 '422': *15 x-github: @@ -32973,17 +33155,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 - *16 responses: '200': description: Response content: application/json: - schema: *220 + schema: *222 examples: - default: *221 + default: *223 '400': *14 '422': *15 x-github: @@ -33008,8 +33190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 - *16 responses: '202': *39 @@ -33038,8 +33220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *76 - - *215 + - *78 + - *217 responses: '204': description: Response @@ -33061,8 +33243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *76 - - &226 + - *78 + - &228 name: actor_type in: path description: The type of the actor @@ -33075,14 +33257,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &227 + - &229 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &222 + - &224 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -33090,7 +33272,7 @@ paths: required: true schema: type: string - - &223 + - &225 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -33183,13 +33365,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *76 - - *222 - - *223 + - *78 + - *224 + - *225 - *19 - *17 - *62 - - &232 + - &234 name: sort description: The property to sort the results by. in: query @@ -33266,15 +33448,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *76 - - *222 - - *223 + - *78 + - *224 + - *225 responses: '200': description: Response content: application/json: - schema: &224 + schema: &226 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -33290,7 +33472,7 @@ paths: type: integer format: int64 examples: - default: &225 + default: &227 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -33310,24 +33492,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *76 - - &228 + - *78 + - &230 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *222 - - *223 + - *224 + - *225 responses: '200': description: Response content: application/json: - schema: *224 + schema: *226 examples: - default: *225 + default: *227 x-github: enabledForGitHubApps: true category: orgs @@ -33345,19 +33527,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *76 - - *222 - - *223 - - *226 - - *227 + - *78 + - *224 + - *225 + - *228 + - *229 responses: '200': description: Response content: application/json: - schema: *224 + schema: *226 examples: - default: *225 + default: *227 x-github: enabledForGitHubApps: true category: orgs @@ -33374,10 +33556,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *76 - - *222 - - *223 - - &229 + - *78 + - *224 + - *225 + - &231 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -33390,7 +33572,7 @@ paths: description: Response content: application/json: - schema: &230 + schema: &232 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -33406,7 +33588,7 @@ paths: type: integer format: int64 examples: - default: &231 + default: &233 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -33442,19 +33624,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *76 - - *228 - - *222 - - *223 - - *229 + - *78 + - *230 + - *224 + - *225 + - *231 responses: '200': description: Response content: application/json: - schema: *230 + schema: *232 examples: - default: *231 + default: *233 x-github: enabledForGitHubApps: true category: orgs @@ -33471,20 +33653,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *76 - - *226 - - *227 - - *222 - - *223 + - *78 + - *228 - *229 + - *224 + - *225 + - *231 responses: '200': description: Response content: application/json: - schema: *230 + schema: *232 examples: - default: *231 + default: *233 x-github: enabledForGitHubApps: true category: orgs @@ -33501,14 +33683,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *76 - - *228 - - *222 - - *223 + - *78 + - *230 + - *224 + - *225 - *19 - *17 - *62 - - *232 + - *234 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -33581,7 +33763,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *76 + - *78 responses: '200': description: Response @@ -33589,7 +33771,7 @@ paths: application/json: schema: *22 examples: - default: &541 + default: &543 value: id: 1 account: @@ -33658,7 +33840,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -33728,7 +33910,7 @@ paths: suspended_at: suspended_by: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33747,7 +33929,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -33755,12 +33937,12 @@ paths: application/json: schema: anyOf: - - &234 + - &236 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &233 + limit: &235 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -33785,7 +33967,7 @@ paths: properties: {} additionalProperties: false examples: - default: &235 + default: &237 value: limit: collaborators_only origin: organization @@ -33809,18 +33991,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &542 + schema: &544 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *233 + limit: *235 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -33844,9 +34026,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *236 examples: - default: *235 + default: *237 '422': *15 x-github: githubCloudOnly: false @@ -33864,7 +34046,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -33888,7 +34070,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *76 + - *78 - *17 - *19 - name: role @@ -33922,11 +34104,11 @@ paths: application/json: schema: type: array - items: *236 + items: *238 examples: - default: *237 + default: *239 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -33947,7 +34129,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *76 + - *78 requestBody: required: false content: @@ -34001,7 +34183,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *238 examples: default: value: @@ -34055,8 +34237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *76 - - &238 + - *78 + - &240 name: invitation_id description: The unique identifier of the invitation. in: path @@ -34086,8 +34268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *76 - - *238 + - *78 + - *240 - *17 - *19 responses: @@ -34097,9 +34279,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: &259 + default: &261 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -34115,7 +34297,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -34134,7 +34316,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#list-issue-fields-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -34142,7 +34324,7 @@ paths: application/json: schema: type: array - items: &239 + items: &241 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -34285,7 +34467,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#create-issue-field-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -34375,9 +34557,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *241 examples: - default: &240 + default: &242 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -34432,8 +34614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - - *76 - - &241 + - *78 + - &243 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -34541,9 +34723,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *241 examples: - default: *240 + default: *242 '404': *6 '422': *7 x-github: @@ -34567,8 +34749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - - *76 - - *241 + - *78 + - *243 responses: '204': *61 '404': *6 @@ -34590,7 +34772,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -34598,7 +34780,7 @@ paths: application/json: schema: type: array - items: *242 + items: *244 examples: default: value: @@ -34636,7 +34818,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -34683,9 +34865,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *244 examples: - default: &243 + default: &245 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -34717,8 +34899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *76 - - &244 + - *78 + - &246 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -34771,9 +34953,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *244 examples: - default: *243 + default: *245 '404': *6 '422': *7 x-github: @@ -34797,8 +34979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *76 - - *244 + - *78 + - *246 responses: '204': description: Response @@ -34831,7 +35013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *76 + - *78 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -34861,7 +35043,7 @@ paths: - closed - all default: open - - *245 + - *247 - name: type description: Can be the name of an issue type. in: query @@ -34880,7 +35062,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -34890,11 +35072,11 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *246 + default: *248 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -34914,7 +35096,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *76 + - *78 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -34952,9 +35134,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -34972,8 +35154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response if requester is an organization member and user is @@ -35007,8 +35189,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -35035,8 +35217,8 @@ paths: parameters: - *17 - *19 - - *76 - - *72 + - *78 + - *74 responses: '200': description: Response @@ -35052,9 +35234,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *249 examples: - default: *248 + default: *250 '304': *37 '500': *55 '401': *25 @@ -35079,9 +35261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *76 - - *72 - - &249 + - *78 + - *74 + - &251 name: codespace_name in: path required: true @@ -35114,17 +35296,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *76 - - *72 - - *249 + - *78 + - *74 + - *251 responses: '200': description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: &463 + default: &465 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -35297,14 +35479,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *250 + schema: *252 examples: default: value: @@ -35373,14 +35555,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '200': description: Response content: application/json: - schema: &251 + schema: &253 title: Org Membership description: Org Membership type: object @@ -35424,7 +35606,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *74 + organization: *76 user: title: Simple User description: A GitHub user. @@ -35447,7 +35629,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &252 + response-if-user-has-an-active-admin-membership-with-organization: &254 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -35519,8 +35701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 requestBody: required: false content: @@ -35548,9 +35730,9 @@ paths: description: Response content: application/json: - schema: *251 + schema: *253 examples: - response-if-user-already-had-membership-with-organization: *252 + response-if-user-already-had-membership-with-organization: *254 '422': *15 '403': *29 '451': *15 @@ -35575,8 +35757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -35601,7 +35783,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *76 + - *78 - *17 - *19 - name: exclude @@ -35622,7 +35804,7 @@ paths: application/json: schema: type: array - items: &253 + items: &255 title: Migration description: A migration. type: object @@ -35859,7 +36041,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -35875,7 +36057,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *76 + - *78 requestBody: required: true content: @@ -35951,7 +36133,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *255 examples: default: value: @@ -36129,8 +36311,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *76 - - &254 + - *78 + - &256 name: migration_id description: The unique identifier of the migration. in: path @@ -36157,7 +36339,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *253 + schema: *255 examples: default: value: @@ -36326,8 +36508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *76 - - *254 + - *78 + - *256 responses: '302': description: Response @@ -36348,8 +36530,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *76 - - *254 + - *78 + - *256 responses: '204': description: Response @@ -36372,9 +36554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *76 - - *254 - - &697 + - *78 + - *256 + - &699 name: repo_name description: repo_name parameter in: path @@ -36401,8 +36583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *76 - - *254 + - *78 + - *256 - *17 - *19 responses: @@ -36414,7 +36596,7 @@ paths: type: array items: *67 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -36440,7 +36622,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response - list of organization roles @@ -36456,7 +36638,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &256 + items: &258 title: Organization Role description: Organization roles type: object @@ -36603,8 +36785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -36629,9 +36811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *76 - *78 - - &255 + - *80 + - &257 name: role_id description: The unique identifier of the role. in: path @@ -36666,9 +36848,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *76 - *78 - - *255 + - *80 + - *257 responses: '204': description: Response @@ -36693,8 +36875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -36719,9 +36901,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *76 - - *72 - - *255 + - *78 + - *74 + - *257 responses: '204': description: Response @@ -36751,9 +36933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *76 - - *72 - - *255 + - *78 + - *74 + - *257 responses: '204': description: Response @@ -36781,14 +36963,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *76 - - *255 + - *78 + - *257 responses: '200': description: Response content: application/json: - schema: *256 + schema: *258 examples: default: value: @@ -36838,8 +37020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *76 - - *255 + - *78 + - *257 - *17 - *19 responses: @@ -36917,8 +37099,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *259 + required: *260 nullable: true type: description: The ownership type of the team @@ -36950,9 +37132,9 @@ paths: - type - parent examples: - default: *259 + default: *261 headers: - Link: *68 + Link: *70 '404': description: Response if the organization or role does not exist. '422': @@ -36979,8 +37161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *76 - - *255 + - *78 + - *257 - *17 - *19 responses: @@ -37008,13 +37190,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &331 + items: &333 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *259 + required: *260 name: nullable: true type: string @@ -37109,9 +37291,9 @@ paths: - type - url examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': description: Response if the organization or role does not exist. '422': @@ -37133,7 +37315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *76 + - *78 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -37160,9 +37342,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37185,8 +37367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *76 - - *72 + - *78 + - *74 requestBody: required: false content: @@ -37243,8 +37425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -37301,8 +37483,8 @@ paths: - docker - nuget - container - - *76 - - &698 + - *78 + - &700 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -37338,12 +37520,12 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: *261 + default: *263 '403': *29 '401': *25 - '400': &700 + '400': &702 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -37365,7 +37547,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &262 + - &264 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -37383,20 +37565,20 @@ paths: - docker - nuget - container - - &263 + - &265 name: package_name description: The name of the package. in: path required: true schema: type: string - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *260 + schema: *262 examples: default: value: @@ -37448,9 +37630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *262 - - *263 - - *76 + - *264 + - *265 + - *78 responses: '204': description: Response @@ -37482,9 +37664,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *262 - - *263 - - *76 + - *264 + - *265 + - *78 - name: token description: package token schema: @@ -37516,9 +37698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *262 - - *263 - - *76 + - *264 + - *265 + - *78 - *19 - *17 - name: state @@ -37538,7 +37720,7 @@ paths: application/json: schema: type: array - items: &264 + items: &266 title: Package Version description: A version of a software package type: object @@ -37663,10 +37845,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *262 - - *263 - - *76 - - &265 + - *264 + - *265 + - *78 + - &267 name: package_version_id description: Unique identifier of the package version. in: path @@ -37678,7 +37860,7 @@ paths: description: Response content: application/json: - schema: *264 + schema: *266 examples: default: value: @@ -37714,10 +37896,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *262 - - *263 - - *76 + - *264 - *265 + - *78 + - *267 responses: '204': description: Response @@ -37749,10 +37931,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *262 - - *263 - - *76 + - *264 - *265 + - *78 + - *267 responses: '204': description: Response @@ -37779,10 +37961,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *76 + - *78 - *17 - *19 - - &266 + - &268 name: sort description: The property by which to sort the results. in: query @@ -37793,7 +37975,7 @@ paths: - created_at default: created_at - *62 - - &267 + - &269 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -37804,7 +37986,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &268 + - &270 name: repository description: The name of the repository to use to filter the results. in: query @@ -37812,7 +37994,7 @@ paths: schema: type: string example: Hello-World - - &269 + - &271 name: permission description: The permission to use to filter the results. in: query @@ -37820,7 +38002,7 @@ paths: schema: type: string example: issues_read - - &270 + - &272 name: last_used_before 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) @@ -37830,7 +38012,7 @@ paths: schema: type: string format: date-time - - &271 + - &273 name: last_used_after 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) @@ -37840,7 +38022,7 @@ paths: schema: type: string format: date-time - - &272 + - &274 name: token_id description: The ID of the token in: query @@ -37984,7 +38166,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38004,7 +38186,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *76 + - *78 requestBody: required: true content: @@ -38070,7 +38252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *76 + - *78 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -38131,7 +38313,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *76 + - *78 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -38151,9 +38333,9 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: &273 + default: &275 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -38266,7 +38448,7 @@ paths: secret_scanning_delegated_alert_dismissal: status: disabled headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38287,17 +38469,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *76 + - *78 - *17 - *19 - - *266 - - *62 - - *267 - *268 + - *62 - *269 - *270 - *271 - *272 + - *273 + - *274 responses: '500': *55 '422': *15 @@ -38426,7 +38608,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38446,7 +38628,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *76 + - *78 requestBody: required: true content: @@ -38506,7 +38688,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *76 + - *78 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -38558,7 +38740,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *76 + - *78 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -38577,11 +38759,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *273 + default: *275 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38603,7 +38785,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -38621,7 +38803,7 @@ paths: type: integer configurations: type: array - items: &274 + items: &276 title: Organization private registry description: Private registry configuration for an organization type: object @@ -38750,7 +38932,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *68 + Link: *70 '400': *14 '404': *6 x-github: @@ -38773,7 +38955,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -39092,7 +39274,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &275 + org-private-registry-with-selected-visibility: &277 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -39133,7 +39315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -39159,7 +39341,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -39181,16 +39363,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *274 + schema: *276 examples: - default: *275 + default: *277 '404': *6 x-github: githubCloudOnly: false @@ -39212,8 +39394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -39389,8 +39571,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -39413,7 +39595,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *76 + - *78 - name: q description: Limit results to projects of the specified type. in: query @@ -39430,7 +39612,7 @@ paths: application/json: schema: type: array - items: &276 + items: &278 title: Projects v2 Project description: A projects v2 project type: object @@ -39500,7 +39682,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &789 + properties: &791 id: type: number description: The unique identifier of the status update. @@ -39548,7 +39730,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &790 + required: &792 - id - node_id - created_at @@ -39573,7 +39755,7 @@ paths: - deleted_at - deleted_by examples: - default: &277 + default: &279 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -39656,7 +39838,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -39676,24 +39858,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &278 + - &280 name: project_number description: The project's number. in: path required: true schema: type: integer - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *276 + schema: *278 examples: - default: *277 + default: *279 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -39713,8 +39895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *76 - - *278 + - *78 + - *280 requestBody: required: true description: Details of the draft item to create in the project. @@ -39748,7 +39930,7 @@ paths: description: Response content: application/json: - schema: &284 + schema: &286 title: Projects v2 Item description: An item belonging to a project type: object @@ -39761,8 +39943,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *86 - - &480 + - *88 + - &482 title: Pull Request Simple description: Pull Request Simple type: object @@ -39868,8 +40050,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *281 + required: *282 nullable: true active_lock_reason: type: string @@ -39901,7 +40083,7 @@ paths: items: *4 requested_teams: type: array - items: *195 + items: *197 head: type: object properties: @@ -39909,7 +40091,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: @@ -39932,7 +40114,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: @@ -39951,7 +40133,7 @@ paths: _links: type: object properties: - comments: &281 + comments: &283 title: Link description: Hypermedia Link type: object @@ -39960,13 +40142,13 @@ paths: type: string required: - href - commits: *281 - statuses: *281 - html: *281 - issue: *281 - review_comments: *281 - review_comment: *281 - self: *281 + commits: *283 + statuses: *283 + html: *283 + issue: *283 + review_comments: *283 + review_comment: *283 + self: *283 required: - comments - commits @@ -39976,8 +40158,8 @@ paths: - review_comments - review_comment - self - author_association: *83 - auto_merge: &593 + author_association: *85 + auto_merge: &595 title: Auto merge description: The status of auto merging a pull request. type: object @@ -40077,7 +40259,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &283 + content_type: &285 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -40117,7 +40299,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &285 + draft_issue: &287 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -40191,8 +40373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *278 - - *76 + - *280 + - *78 - *17 - *47 - *48 @@ -40203,7 +40385,7 @@ paths: application/json: schema: type: array - items: &282 + items: &284 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -40353,7 +40535,7 @@ paths: - updated_at - project_url examples: - default: &720 + default: &722 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40464,7 +40646,7 @@ paths: created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -40483,8 +40665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *278 - - *76 + - *280 + - *78 requestBody: required: true content: @@ -40530,7 +40712,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &721 + items: &723 type: object properties: name: @@ -40567,7 +40749,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &722 + iteration_configuration: &724 type: object description: The configuration for iteration fields. properties: @@ -40617,7 +40799,7 @@ paths: value: name: Due date data_type: date - single_select_field: &723 + single_select_field: &725 summary: Create a single select field value: name: Priority @@ -40644,7 +40826,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &724 + iteration_field: &726 summary: Create an iteration field value: name: Sprint @@ -40668,9 +40850,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *282 + schema: *284 examples: - text_field: &725 + text_field: &727 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -40679,7 +40861,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &726 + number_field: &728 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -40688,7 +40870,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &727 + date_field: &729 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -40697,7 +40879,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &728 + single_select_field: &730 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40731,7 +40913,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &729 + iteration_field: &731 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -40776,23 +40958,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *278 - - &730 + - *280 + - &732 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *282 + schema: *284 examples: - default: &731 + default: &733 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40827,7 +41009,7 @@ paths: created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -40848,8 +41030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *278 - - *76 + - *280 + - *78 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -40881,7 +41063,7 @@ paths: application/json: schema: type: array - items: &286 + items: &288 title: Projects v2 Item description: An item belonging to a project type: object @@ -40897,7 +41079,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *283 + content_type: *285 content: type: object additionalProperties: true @@ -40940,7 +41122,7 @@ paths: - updated_at - archived_at examples: - default: &287 + default: &289 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -41617,7 +41799,7 @@ paths: data_type: sub_issues_progress value: headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -41637,8 +41819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *76 - - *278 + - *78 + - *280 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -41708,22 +41890,22 @@ paths: description: Response content: application/json: - schema: *284 + schema: *286 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *285 + value: *287 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *285 + value: *287 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *285 + value: *287 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *285 + value: *287 '304': *37 '403': *29 '401': *25 @@ -41743,9 +41925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *278 - - *76 - - &288 + - *280 + - *78 + - &290 name: item_id description: The unique identifier of the project item. in: path @@ -41771,11 +41953,11 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -41794,9 +41976,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *278 - - *76 - - *288 + - *280 + - *78 + - *290 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -41866,13 +42048,13 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - text_field: *287 - number_field: *287 - date_field: *287 - single_select_field: *287 - iteration_field: *287 + text_field: *289 + number_field: *289 + date_field: *289 + single_select_field: *289 + iteration_field: *289 '401': *25 '403': *29 '404': *6 @@ -41892,9 +42074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *278 - - *76 - - *288 + - *280 + - *78 + - *290 responses: '204': description: Response @@ -41917,8 +42099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - - *76 - - *278 + - *78 + - *280 requestBody: required: true content: @@ -41989,7 +42171,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &712 + schema: &714 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -42087,7 +42269,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &289 + value: &291 value: id: 1 number: 1 @@ -42133,10 +42315,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *289 + value: *291 roadmap_view: summary: Response for creating a roadmap view - value: *289 + value: *291 '304': *37 '403': *29 '401': *25 @@ -42164,9 +42346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *278 - - *76 - - &732 + - *280 + - *78 + - &734 name: view_number description: The number that identifies the project view. in: path @@ -42198,11 +42380,11 @@ paths: application/json: schema: type: array - items: *286 + items: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -42225,7 +42407,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -42233,7 +42415,7 @@ paths: application/json: schema: type: array - items: &290 + items: &292 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -42301,7 +42483,7 @@ paths: - property_name - value_type examples: - default: &291 + default: &293 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42350,7 +42532,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -42361,7 +42543,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *290 + items: *292 minItems: 1 maxItems: 100 required: @@ -42391,9 +42573,9 @@ paths: application/json: schema: type: array - items: *290 + items: *292 examples: - default: *291 + default: *293 '403': *29 '404': *6 x-github: @@ -42414,8 +42596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *76 - - &292 + - *78 + - &294 name: custom_property_name description: The custom property name in: path @@ -42427,9 +42609,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *292 examples: - default: &293 + default: &295 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42463,8 +42645,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *76 - - *292 + - *78 + - *294 requestBody: required: true content: @@ -42535,9 +42717,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *292 examples: - default: *293 + default: *295 '403': *29 '404': *6 x-github: @@ -42560,8 +42742,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *76 - - *292 + - *78 + - *294 responses: '204': *61 '403': *29 @@ -42584,7 +42766,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *76 + - *78 - *17 - *19 - name: repository_query @@ -42622,7 +42804,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &294 + items: &296 title: Custom Property Value description: Custom property name and associated value type: object @@ -42661,7 +42843,7 @@ paths: - property_name: team value: octocat headers: - Link: *68 + Link: *70 '403': *29 '404': *6 x-github: @@ -42689,7 +42871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *76 + - *78 requestBody: required: true content: @@ -42709,7 +42891,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *294 + items: *296 required: - repository_names - properties @@ -42750,7 +42932,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *76 + - *78 - *17 - *19 responses: @@ -42762,9 +42944,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42781,8 +42963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response if user is a public member @@ -42806,8 +42988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -42828,8 +43010,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -42853,7 +43035,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *76 + - *78 - name: type description: Specifies the types of repositories you want returned. in: query @@ -42899,11 +43081,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *273 + default: *275 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42922,7 +43104,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *76 + - *78 requestBody: required: true content: @@ -43103,7 +43285,7 @@ paths: description: Response content: application/json: - schema: &345 + schema: &347 title: Full Repository description: Full Repository type: object @@ -43388,8 +43570,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *295 - required: *296 + properties: *297 + required: *298 nullable: true temp_clone_token: type: string @@ -43473,8 +43655,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true organization: title: Simple User @@ -43483,8 +43665,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *80 - source: *80 + parent: *82 + source: *82 forks: type: integer master_branch: @@ -43501,7 +43683,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &485 + properties: &487 url: type: string format: uri @@ -43517,12 +43699,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &486 + required: &488 - url - key - name - html_url - security_and_analysis: *297 + security_and_analysis: *299 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -43606,7 +43788,7 @@ paths: - network_count - subscribers_count examples: - default: &347 + default: &349 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -44124,10 +44306,10 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - *17 - *19 - - &615 + - &617 name: targets description: | A comma-separated list of rule targets to filter by. @@ -44145,7 +44327,7 @@ paths: application/json: schema: type: array - items: &324 + items: &326 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -44180,7 +44362,7 @@ paths: source: type: string description: The name of the source - enforcement: &300 + enforcement: &302 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -44193,7 +44375,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &301 + items: &303 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -44263,7 +44445,7 @@ paths: conditions: nullable: true anyOf: - - &298 + - &300 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -44287,7 +44469,7 @@ paths: match. items: type: string - - &302 + - &304 title: Organization ruleset conditions type: object description: |- @@ -44301,7 +44483,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *298 + - *300 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -44335,7 +44517,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *298 + - *300 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -44357,7 +44539,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *298 + - *300 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -44370,7 +44552,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &299 + items: &301 title: Repository ruleset property targeting definition type: object @@ -44403,17 +44585,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *299 + items: *301 required: - repository_property rules: type: array - items: &616 + items: &618 title: Repository Rule type: object description: A repository rule. oneOf: - - &303 + - &305 title: creation description: Only allow users with bypass permission to create matching refs. @@ -44425,7 +44607,7 @@ paths: type: string enum: - creation - - &304 + - &306 title: update description: Only allow users with bypass permission to update matching refs. @@ -44446,7 +44628,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &305 + - &307 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -44458,7 +44640,7 @@ paths: type: string enum: - deletion - - &306 + - &308 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -44470,7 +44652,7 @@ paths: type: string enum: - required_linear_history - - &614 + - &616 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -44548,7 +44730,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &307 + - &309 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -44572,7 +44754,7 @@ paths: type: string required: - required_deployment_environments - - &308 + - &310 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -44584,7 +44766,7 @@ paths: type: string enum: - required_signatures - - &309 + - &311 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -44690,7 +44872,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &310 + - &312 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -44738,7 +44920,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &311 + - &313 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -44750,7 +44932,7 @@ paths: type: string enum: - non_fast_forward - - &312 + - &314 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -44787,7 +44969,7 @@ paths: required: - operator - pattern - - &313 + - &315 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -44824,7 +45006,7 @@ paths: required: - operator - pattern - - &314 + - &316 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -44861,7 +45043,7 @@ paths: required: - operator - pattern - - &315 + - &317 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -44898,7 +45080,7 @@ paths: required: - operator - pattern - - &316 + - &318 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -44935,7 +45117,7 @@ paths: required: - operator - pattern - - &317 + - &319 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -44960,7 +45142,7 @@ paths: type: string required: - restricted_file_paths - - &318 + - &320 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -44984,7 +45166,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &319 + - &321 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -45007,7 +45189,7 @@ paths: type: string required: - restricted_file_extensions - - &320 + - &322 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -45032,7 +45214,7 @@ paths: maximum: 100 required: - max_file_size - - &321 + - &323 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -45082,7 +45264,7 @@ paths: - repository_id required: - workflows - - &322 + - &324 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -45143,7 +45325,7 @@ paths: - tool required: - code_scanning_tools - - &323 + - &325 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -45221,7 +45403,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 requestBody: description: Request body required: true @@ -45242,22 +45424,20 @@ paths: - push - repository default: branch - enforcement: *300 + enforcement: *302 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *302 + items: *303 + conditions: *304 rules: type: array description: An array of rules within the ruleset. - items: &326 + items: &328 title: Repository Rule type: object description: A repository rule. oneOf: - - *303 - - *304 - *305 - *306 - *307 @@ -45277,6 +45457,8 @@ paths: - *321 - *322 - *323 + - *324 + - *325 required: - name - enforcement @@ -45314,9 +45496,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: &325 + default: &327 value: id: 21 name: super cool ruleset @@ -45371,8 +45553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *76 - - &617 + - *78 + - &619 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -45387,7 +45569,7 @@ paths: in: query schema: type: string - - &618 + - &620 name: time_period description: |- The time period to filter by. @@ -45403,14 +45585,14 @@ paths: - week - month default: day - - &619 + - &621 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &620 + - &622 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45430,7 +45612,7 @@ paths: description: Response content: application/json: - schema: &621 + schema: &623 title: Rule Suites description: Response type: array @@ -45485,7 +45667,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &622 + default: &624 value: - id: 21 actor_id: 12 @@ -45528,8 +45710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *76 - - &623 + - *78 + - &625 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45545,7 +45727,7 @@ paths: description: Response content: application/json: - schema: &624 + schema: &626 title: Rule Suite description: Response type: object @@ -45644,7 +45826,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &625 + default: &627 value: id: 21 actor_id: 12 @@ -45705,7 +45887,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -45717,9 +45899,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: *325 + default: *327 '404': *6 '500': *55 put: @@ -45737,7 +45919,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -45763,16 +45945,16 @@ paths: - tag - push - repository - enforcement: *300 + enforcement: *302 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *302 + items: *303 + conditions: *304 rules: description: An array of rules within the ruleset. type: array - items: *326 + items: *328 examples: default: value: @@ -45807,9 +45989,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: *325 + default: *327 '404': *6 '422': *15 '500': *55 @@ -45828,7 +46010,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -45851,7 +46033,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *76 + - *78 - *17 - *19 - name: ruleset_id @@ -45867,7 +46049,7 @@ paths: application/json: schema: type: array - items: &327 + items: &329 title: Ruleset version type: object description: The historical version of a ruleset @@ -45891,7 +46073,7 @@ paths: type: string format: date-time examples: - default: &627 + default: &629 value: - version_id: 3 actor: @@ -45926,7 +46108,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -45944,9 +46126,9 @@ paths: description: Response content: application/json: - schema: &628 + schema: &630 allOf: - - *327 + - *329 - type: object required: - state @@ -46015,8 +46197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *76 - - &629 + - *78 + - &631 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -46027,7 +46209,7 @@ paths: enum: - open - resolved - - &630 + - &632 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -46037,7 +46219,7 @@ paths: required: false schema: type: string - - &631 + - &633 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -46048,7 +46230,7 @@ paths: required: false schema: type: string - - &632 + - &634 name: exclude_providers in: query description: |- @@ -46059,7 +46241,7 @@ paths: required: false schema: type: string - - &633 + - &635 name: providers in: query description: |- @@ -46070,7 +46252,7 @@ paths: required: false schema: type: string - - &634 + - &636 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46079,7 +46261,7 @@ paths: required: false schema: type: string - - &635 + - &637 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46098,7 +46280,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &636 + - &638 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -46113,7 +46295,7 @@ paths: - *62 - *19 - *17 - - &637 + - &639 name: before 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 @@ -46123,7 +46305,7 @@ paths: required: false schema: type: string - - &638 + - &640 name: after 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 @@ -46133,7 +46315,7 @@ paths: required: false schema: type: string - - &639 + - &641 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46142,7 +46324,7 @@ paths: required: false schema: type: string - - &640 + - &642 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46151,7 +46333,7 @@ paths: schema: type: boolean default: false - - &641 + - &643 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46160,7 +46342,7 @@ paths: schema: type: boolean default: false - - &642 + - &644 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -46179,8 +46361,8 @@ paths: items: type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -46188,21 +46370,21 @@ paths: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &643 + state: &645 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &644 + resolution: &646 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -46319,8 +46501,8 @@ paths: pull request. ' - oneOf: &645 - - &647 + oneOf: &647 + - &649 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -46378,7 +46560,7 @@ paths: - blob_url - commit_sha - commit_url - - &648 + - &650 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -46433,7 +46615,7 @@ paths: - page_url - commit_sha - commit_url - - &649 + - &651 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -46453,7 +46635,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &650 + - &652 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -46473,7 +46655,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &651 + - &653 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -46493,7 +46675,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &652 + - &654 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -46507,7 +46689,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &653 + - &655 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -46521,7 +46703,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &654 + - &656 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -46535,7 +46717,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &655 + - &657 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -46555,7 +46737,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &656 + - &658 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -46575,7 +46757,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &657 + - &659 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -46595,7 +46777,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &658 + - &660 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -46615,7 +46797,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &659 + - &661 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -46839,9 +47021,9 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46866,7 +47048,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *78 responses: '200': description: Response @@ -46878,7 +47060,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &329 + pattern_config_version: &331 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -46887,7 +47069,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &328 + items: &330 type: object properties: token_type: @@ -46953,7 +47135,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *328 + items: *330 examples: default: value: @@ -47002,7 +47184,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *78 requestBody: required: true content: @@ -47010,7 +47192,7 @@ paths: schema: type: object properties: - pattern_config_version: *329 + pattern_config_version: *331 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -47036,7 +47218,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *329 + custom_pattern_version: *331 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -47090,7 +47272,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *76 + - *78 - *62 - name: sort description: The property to sort the results by. @@ -47134,7 +47316,7 @@ paths: application/json: schema: type: array - items: &663 + items: &665 description: A repository security advisory. type: object properties: @@ -47336,7 +47518,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *332 credits_detailed: type: array nullable: true @@ -47346,7 +47528,7 @@ paths: type: object properties: user: *4 - type: *330 + type: *332 state: type: string description: The state of the user's acceptance of the @@ -47370,7 +47552,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *195 + items: *197 private_fork: readOnly: true nullable: true @@ -47406,7 +47588,7 @@ paths: - private_fork additionalProperties: false examples: - default: &664 + default: &666 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -47785,7 +47967,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *76 + - *78 responses: '200': description: Response @@ -47793,7 +47975,7 @@ paths: application/json: schema: type: array - items: *331 + items: *333 examples: default: value: @@ -47833,8 +48015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -47859,8 +48041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -47887,7 +48069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Immutable releases settings response @@ -47936,7 +48118,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -47993,7 +48175,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *76 + - *78 - *19 - *17 responses: @@ -48011,9 +48193,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48032,7 +48214,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *76 + - *78 requestBody: required: true content: @@ -48081,8 +48263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -48104,8 +48286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -48128,7 +48310,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -48146,7 +48328,7 @@ paths: type: integer network_configurations: type: array - items: &332 + items: &334 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -48217,7 +48399,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48236,7 +48418,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -48292,9 +48474,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *334 examples: - default: &333 + default: &335 value: id: 123456789ABCDEF name: My network configuration @@ -48322,8 +48504,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 - - &334 + - *78 + - &336 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -48335,11 +48517,11 @@ paths: description: Response content: application/json: - schema: *332 + schema: *334 examples: - default: *333 + default: *335 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48358,8 +48540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 - - *334 + - *78 + - *336 requestBody: required: true content: @@ -48412,9 +48594,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *334 examples: - default: *333 + default: *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48433,8 +48615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *76 - - *334 + - *78 + - *336 responses: '204': description: Response @@ -48457,7 +48639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *76 + - *78 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -48511,7 +48693,7 @@ paths: subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" region: eastus headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48541,8 +48723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *76 - *78 + - *80 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -48574,13 +48756,13 @@ paths: application/json: schema: type: array - items: *335 + items: *337 examples: - default: *336 + default: *338 '500': *55 '403': *29 '404': *6 - '422': *337 + '422': *339 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48598,7 +48780,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *76 + - *78 - *17 - *19 - name: team_type @@ -48620,11 +48802,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -48644,7 +48826,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *76 + - *78 requestBody: required: true content: @@ -48708,7 +48890,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &340 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -48771,8 +48953,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *259 + required: *260 nullable: true members_count: type: integer @@ -49035,7 +49217,7 @@ paths: - repos_count - organization examples: - default: &339 + default: &341 value: id: 1 node_id: MDQ6VGVhbTE= @@ -49105,16 +49287,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *76 - *78 + - *80 responses: '200': description: Response content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '404': *6 x-github: githubCloudOnly: false @@ -49135,8 +49317,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *76 - *78 + - *80 requestBody: required: false content: @@ -49198,16 +49380,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '201': description: Response content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '404': *6 '422': *15 '403': *29 @@ -49232,12 +49414,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response - '422': &340 + '422': &342 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -49260,8 +49442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -49271,12 +49453,12 @@ paths: application/json: schema: type: array - items: *236 + items: *238 examples: - default: *237 + default: *239 headers: - Link: *68 - '422': *340 + Link: *70 + '422': *342 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49296,8 +49478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *76 - *78 + - *80 - name: role description: Filters members returned by their role in the team. in: query @@ -49320,9 +49502,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49350,15 +49532,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 responses: '200': description: Response content: application/json: - schema: &341 + schema: &343 title: Team Membership description: Team Membership type: object @@ -49385,7 +49567,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &679 + response-if-user-is-a-team-maintainer: &681 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -49421,9 +49603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 requestBody: required: false content: @@ -49448,9 +49630,9 @@ paths: description: Response content: application/json: - schema: *341 + schema: *343 examples: - response-if-users-membership-with-team-is-now-pending: &680 + response-if-users-membership-with-team-is-now-pending: &682 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -49485,9 +49667,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 responses: '204': description: Response @@ -49513,8 +49695,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -49524,11 +49706,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *273 + default: *275 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49555,16 +49737,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *76 - *78 - - *342 - - *343 + - *80 + - *344 + - *345 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &681 + schema: &683 title: Team Repository description: A team's access to a repository. type: object @@ -49587,8 +49769,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true forks: type: integer @@ -50126,10 +50308,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *76 - *78 - - *342 - - *343 + - *80 + - *344 + - *345 requestBody: required: false content: @@ -50174,10 +50356,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *76 - *78 - - *342 - - *343 + - *80 + - *344 + - *345 responses: '204': description: Response @@ -50201,8 +50383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -50212,9 +50394,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - response-if-child-teams-exist: &682 + response-if-child-teams-exist: &684 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -50242,7 +50424,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50267,7 +50449,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *76 + - *78 - name: security_product in: path description: The security feature to enable or disable. @@ -50368,7 +50550,7 @@ paths: resources: type: object properties: - core: &344 + core: &346 title: Rate Limit type: object properties: @@ -50385,17 +50567,17 @@ paths: - remaining - reset - used - graphql: *344 - search: *344 - code_search: *344 - source_import: *344 - integration_manifest: *344 - code_scanning_upload: *344 - actions_runner_registration: *344 - scim: *344 - dependency_snapshots: *344 - dependency_sbom: *344 - code_scanning_autofix: *344 + graphql: *346 + search: *346 + code_search: *346 + source_import: *346 + integration_manifest: *346 + code_scanning_upload: *346 + actions_runner_registration: *346 + scim: *346 + dependency_snapshots: *346 + dependency_sbom: *346 + code_scanning_autofix: *346 required: - core - search @@ -50497,14 +50679,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *345 + schema: *347 examples: default-response: summary: Default response @@ -51008,7 +51190,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *346 + '301': *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51026,8 +51208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -51325,10 +51507,10 @@ paths: description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 - '307': &348 + default: *349 + '307': &350 description: Temporary Redirect content: application/json: @@ -51357,8 +51539,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -51380,7 +51562,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *348 + '307': *350 '404': *6 '409': *54 x-github: @@ -51404,11 +51586,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 - - &381 + - &383 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -51431,7 +51613,7 @@ paths: type: integer artifacts: type: array - items: &349 + items: &351 title: Artifact description: An artifact type: object @@ -51509,7 +51691,7 @@ paths: - expires_at - updated_at examples: - default: &382 + default: &384 value: total_count: 2 artifacts: @@ -51548,7 +51730,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51570,9 +51752,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *342 - - *343 - - &350 + - *344 + - *345 + - &352 name: artifact_id description: The unique identifier of the artifact. in: path @@ -51584,7 +51766,7 @@ paths: description: Response content: application/json: - schema: *349 + schema: *351 examples: default: value: @@ -51622,9 +51804,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *342 - - *343 - - *350 + - *344 + - *345 + - *352 responses: '204': description: Response @@ -51648,9 +51830,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *342 - - *343 - - *350 + - *344 + - *345 + - *352 - name: archive_format in: path required: true @@ -51660,11 +51842,11 @@ paths: '302': description: Response headers: - Location: &504 + Location: &506 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &545 + '410': &547 description: Gone content: application/json: @@ -51689,14 +51871,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &351 + schema: &353 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -51729,13 +51911,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *351 + schema: *353 examples: selected_actions: *42 responses: @@ -51764,14 +51946,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &352 + schema: &354 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -51804,13 +51986,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *352 + schema: *354 examples: selected_actions: *44 responses: @@ -51841,14 +52023,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *353 + schema: *355 examples: default: value: @@ -51874,11 +52056,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 - - &354 + - &356 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -51912,7 +52094,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &357 title: Repository actions caches description: Repository actions caches type: object @@ -51954,7 +52136,7 @@ paths: - total_count - actions_caches examples: - default: &356 + default: &358 value: total_count: 1 actions_caches: @@ -51966,7 +52148,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51986,23 +52168,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *342 - - *343 + - *344 + - *345 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *354 + - *356 responses: '200': description: Response content: application/json: - schema: *355 + schema: *357 examples: - default: *356 + default: *358 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52022,8 +52204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *342 - - *343 + - *344 + - *345 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -52054,9 +52236,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *342 - - *343 - - &357 + - *344 + - *345 + - &359 name: job_id description: The unique identifier of the job. in: path @@ -52068,7 +52250,7 @@ paths: description: Response content: application/json: - schema: &385 + schema: &387 title: Job description: Information of a job execution in a workflow run type: object @@ -52375,9 +52557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *342 - - *343 - - *357 + - *344 + - *345 + - *359 responses: '302': description: Response @@ -52405,9 +52587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *342 - - *343 - - *357 + - *344 + - *345 + - *359 requestBody: required: false content: @@ -52428,7 +52610,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -52452,8 +52634,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Status response @@ -52474,6 +52656,15 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable + OIDC subject claim format. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. If not set at the + repository level, falls back to the organization-level setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default examples: @@ -52503,8 +52694,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -52526,6 +52717,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -52538,7 +52734,7 @@ paths: description: Empty response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -52567,8 +52763,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -52586,7 +52782,7 @@ paths: type: integer secrets: type: array - items: &387 + items: &389 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -52606,7 +52802,7 @@ paths: - created_at - updated_at examples: - default: &388 + default: &390 value: total_count: 2 secrets: @@ -52617,7 +52813,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52639,9 +52835,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *342 - - *343 - - *358 + - *344 + - *345 + - *360 - *19 responses: '200': @@ -52658,7 +52854,7 @@ paths: type: integer variables: type: array - items: &391 + items: &393 title: Actions Variable type: object properties: @@ -52688,7 +52884,7 @@ paths: - created_at - updated_at examples: - default: &392 + default: &394 value: total_count: 2 variables: @@ -52701,7 +52897,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52721,8 +52917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -52731,12 +52927,12 @@ paths: schema: type: object properties: - enabled: &360 + enabled: &362 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *144 - selected_actions_url: *359 - sha_pinning_required: *145 + allowed_actions: *146 + selected_actions_url: *361 + sha_pinning_required: *147 required: - enabled examples: @@ -52764,8 +52960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -52776,9 +52972,9 @@ paths: schema: type: object properties: - enabled: *360 - allowed_actions: *144 - sha_pinning_required: *145 + enabled: *362 + allowed_actions: *146 + sha_pinning_required: *147 required: - enabled examples: @@ -52808,14 +53004,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &361 + schema: &363 type: object properties: access_level: @@ -52832,7 +53028,7 @@ paths: required: - access_level examples: - default: &362 + default: &364 value: access_level: organization x-github: @@ -52856,15 +53052,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *361 + schema: *363 examples: - default: *362 + default: *364 responses: '204': description: Response @@ -52888,14 +53084,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *363 + schema: *365 examples: default: value: @@ -52919,8 +53115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Empty response for successful settings update @@ -52930,7 +53126,7 @@ paths: required: true content: application/json: - schema: *364 + schema: *366 examples: default: summary: Set retention days @@ -52954,16 +53150,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *146 + schema: *148 examples: - default: *365 + default: *367 '404': *6 x-github: enabledForGitHubApps: true @@ -52982,8 +53178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -52993,7 +53189,7 @@ paths: required: true content: application/json: - schema: *146 + schema: *148 examples: default: summary: Set approval policy to first time contributors @@ -53017,16 +53213,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *366 + schema: *368 examples: - default: *147 + default: *149 '403': *29 '404': *6 x-github: @@ -53046,15 +53242,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *367 + schema: *369 examples: - default: *147 + default: *149 responses: '204': description: Empty response for successful settings update @@ -53078,16 +53274,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *149 + schema: *151 examples: - default: *150 + default: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53106,8 +53302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -53115,9 +53311,9 @@ paths: required: false content: application/json: - schema: *149 + schema: *151 examples: - selected_actions: *150 + selected_actions: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53139,16 +53335,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *368 + schema: *370 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53169,8 +53365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Success response @@ -53181,9 +53377,9 @@ paths: required: true content: application/json: - schema: *369 + schema: *371 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53210,8 +53406,8 @@ paths: in: query schema: type: string - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -53229,11 +53425,11 @@ paths: type: integer runners: type: array - items: *161 + items: *163 examples: - default: *162 + default: *164 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53255,8 +53451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -53264,9 +53460,9 @@ paths: application/json: schema: type: array - items: *370 + items: *372 examples: - default: *371 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53288,8 +53484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -53332,7 +53528,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *372 + '201': *374 '404': *6 '422': *7 '409': *54 @@ -53363,16 +53559,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: *373 + default: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53400,16 +53596,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: *374 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53431,17 +53627,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 responses: '200': description: Response content: application/json: - schema: *161 + schema: *163 examples: - default: *375 + default: *377 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53462,9 +53658,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 responses: '204': description: Response @@ -53490,11 +53686,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 responses: - '200': *165 + '200': *167 '404': *6 x-github: githubCloudOnly: false @@ -53516,9 +53712,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 requestBody: required: true content: @@ -53542,7 +53738,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -53566,9 +53762,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 requestBody: required: true content: @@ -53593,7 +53789,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -53617,11 +53813,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 + - *344 + - *345 + - *162 responses: - '200': *376 + '200': *378 '404': *6 x-github: githubCloudOnly: false @@ -53648,12 +53844,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *342 - - *343 - - *160 - - *377 + - *344 + - *345 + - *162 + - *379 responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -53679,9 +53875,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *342 - - *343 - - &395 + - *344 + - *345 + - &397 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -53689,7 +53885,7 @@ paths: required: false schema: type: string - - &396 + - &398 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -53697,7 +53893,7 @@ paths: required: false schema: type: string - - &397 + - &399 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -53706,7 +53902,7 @@ paths: required: false schema: type: string - - &398 + - &400 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -53733,7 +53929,7 @@ paths: - pending - *17 - *19 - - &399 + - &401 name: created 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)." @@ -53742,7 +53938,7 @@ paths: schema: type: string format: date-time - - &378 + - &380 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -53751,13 +53947,13 @@ paths: schema: type: boolean default: false - - &400 + - &402 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &401 + - &403 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -53780,7 +53976,7 @@ paths: type: integer workflow_runs: type: array - items: &379 + items: &381 title: Workflow Run description: An invocation of a workflow type: object @@ -53875,7 +54071,7 @@ paths: that triggered the run. type: array nullable: true - items: *91 + items: *93 created_at: type: string format: date-time @@ -53928,7 +54124,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &423 + properties: &425 id: type: string description: SHA for the commit @@ -53979,7 +54175,7 @@ paths: - name - email nullable: true - required: &424 + required: &426 - id - tree_id - message @@ -53987,8 +54183,8 @@ paths: - author - committer nullable: true - repository: *159 - head_repository: *159 + repository: *161 + head_repository: *161 head_repository_id: type: integer example: 5 @@ -54026,7 +54222,7 @@ paths: - workflow_url - pull_requests examples: - default: &402 + default: &404 value: total_count: 1 workflow_runs: @@ -54240,7 +54436,7 @@ paths: releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54262,24 +54458,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *342 - - *343 - - &380 + - *344 + - *345 + - &382 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *378 + - *380 responses: '200': description: Response content: application/json: - schema: *379 + schema: *381 examples: - default: &383 + default: &385 value: id: 30433642 name: Build @@ -54520,9 +54716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '204': description: Response @@ -54545,9 +54741,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '200': description: Response @@ -54666,15 +54862,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -54701,12 +54897,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 - *17 - *19 - - *381 + - *383 - *62 responses: '200': @@ -54723,11 +54919,11 @@ paths: type: integer artifacts: type: array - items: *349 + items: *351 examples: - default: *382 + default: *384 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54749,25 +54945,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *342 - - *343 - - *380 - - &384 + - *344 + - *345 + - *382 + - &386 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *378 + - *380 responses: '200': description: Response content: application/json: - schema: *379 + schema: *381 examples: - default: *383 + default: *385 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54790,10 +54986,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *342 - - *343 - - *380 - - *384 + - *344 + - *345 + - *382 + - *386 - *17 - *19 responses: @@ -54811,9 +55007,9 @@ paths: type: integer jobs: type: array - items: *385 + items: *387 examples: - default: &386 + default: &388 value: total_count: 1 jobs: @@ -54902,7 +55098,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -54926,10 +55122,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *342 - - *343 - - *380 - - *384 + - *344 + - *345 + - *382 + - *386 responses: '302': description: Response @@ -54957,15 +55153,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '202': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -54992,9 +55188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 requestBody: required: true content: @@ -55061,15 +55257,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '202': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -55096,9 +55292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -55128,11 +55324,11 @@ paths: type: integer jobs: type: array - items: *385 + items: *387 examples: - default: *386 + default: *388 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55155,9 +55351,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '302': description: Response @@ -55184,9 +55380,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '204': description: Response @@ -55213,9 +55409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '200': description: Response @@ -55275,7 +55471,7 @@ paths: items: type: object properties: - type: &511 + type: &513 type: string description: The type of reviewer. enum: @@ -55285,7 +55481,7 @@ paths: reviewer: anyOf: - *4 - - *195 + - *197 required: - environment - wait_timer @@ -55360,9 +55556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 requestBody: required: true content: @@ -55409,12 +55605,12 @@ paths: application/json: schema: type: array - items: &506 + items: &508 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &752 + properties: &754 url: type: string format: uri @@ -55497,9 +55693,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - required: &753 + properties: *83 + required: *84 + required: &755 - id - node_id - sha @@ -55515,7 +55711,7 @@ paths: - created_at - updated_at examples: - default: &507 + default: &509 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -55571,9 +55767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 requestBody: required: false content: @@ -55594,7 +55790,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -55617,9 +55813,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 requestBody: required: false content: @@ -55640,7 +55836,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -55672,9 +55868,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *342 - - *343 - - *380 + - *344 + - *345 + - *382 responses: '200': description: Response @@ -55811,8 +56007,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -55830,11 +56026,11 @@ paths: type: integer secrets: type: array - items: *387 + items: *389 examples: - default: *388 + default: *390 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55857,16 +56053,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *389 + schema: *391 examples: - default: *390 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55888,17 +56084,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '200': description: Response content: application/json: - schema: *387 + schema: *389 examples: - default: &524 + default: &526 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -55924,9 +56120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 requestBody: required: true content: @@ -55957,7 +56153,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -55983,9 +56179,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '204': description: Response @@ -56010,9 +56206,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *342 - - *343 - - *358 + - *344 + - *345 + - *360 - *19 responses: '200': @@ -56029,11 +56225,11 @@ paths: type: integer variables: type: array - items: *391 + items: *393 examples: - default: *392 + default: *394 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56054,8 +56250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -56082,7 +56278,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56107,17 +56303,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *342 - - *343 - - *170 + - *344 + - *345 + - *172 responses: '200': description: Response content: application/json: - schema: *391 + schema: *393 examples: - default: &525 + default: &527 value: name: USERNAME value: octocat @@ -56143,9 +56339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *342 - - *343 - - *170 + - *344 + - *345 + - *172 requestBody: required: true content: @@ -56187,9 +56383,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *342 - - *343 - - *170 + - *344 + - *345 + - *172 responses: '204': description: Response @@ -56214,8 +56410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -56233,7 +56429,7 @@ paths: type: integer workflows: type: array - items: &393 + items: &395 title: Workflow description: A GitHub Actions workflow type: object @@ -56317,7 +56513,7 @@ paths: html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56340,9 +56536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *342 - - *343 - - &394 + - *344 + - *345 + - &396 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -56357,7 +56553,7 @@ paths: description: Response content: application/json: - schema: *393 + schema: *395 examples: default: value: @@ -56390,9 +56586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *342 - - *343 - - *394 + - *344 + - *345 + - *396 responses: '204': description: Response @@ -56417,13 +56613,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *342 - - *343 - - *394 + - *344 + - *345 + - *396 responses: '200': - description: Response including the workflow run ID and URLs when `return_run_details` - parameter is `true`. + description: Response including the workflow run ID and URLs. content: application/json: schema: @@ -56500,9 +56695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *342 - - *343 - - *394 + - *344 + - *345 + - *396 responses: '204': description: Response @@ -56529,19 +56724,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *342 - - *343 - - *394 - - *395 + - *344 + - *345 - *396 - *397 - *398 - - *17 - - *19 - *399 - - *378 - *400 + - *17 + - *19 - *401 + - *380 + - *402 + - *403 responses: '200': description: Response @@ -56557,11 +56752,11 @@ paths: type: integer workflow_runs: type: array - items: *379 + items: *381 examples: - default: *402 + default: *404 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56591,9 +56786,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *342 - - *343 - - *394 + - *344 + - *345 + - *396 responses: '200': description: Response @@ -56654,8 +56849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *342 - - *343 + - *344 + - *345 - *62 - *17 - *47 @@ -56800,7 +56995,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '422': *7 x-github: githubCloudOnly: false @@ -56819,8 +57014,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -56832,9 +57027,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -56857,8 +57052,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *342 - - *343 + - *344 + - *345 - name: assignee in: path required: true @@ -56894,8 +57089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -57005,8 +57200,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *47 - *48 @@ -57047,7 +57242,7 @@ paths: initiator: type: string examples: - default: *403 + default: *405 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57067,8 +57262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -57076,7 +57271,7 @@ paths: application/json: schema: type: array - items: &404 + items: &406 title: Autolink reference description: An autolink reference. type: object @@ -57130,8 +57325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -57170,9 +57365,9 @@ paths: description: response content: application/json: - schema: *404 + schema: *406 examples: - default: &405 + default: &407 value: id: 1 key_prefix: TICKET- @@ -57203,9 +57398,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *342 - - *343 - - &406 + - *344 + - *345 + - &408 name: autolink_id description: The unique identifier of the autolink. in: path @@ -57217,9 +57412,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *406 examples: - default: *405 + default: *407 '404': *6 x-github: githubCloudOnly: false @@ -57239,9 +57434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *342 - - *343 - - *406 + - *344 + - *345 + - *408 responses: '204': description: Response @@ -57265,8 +57460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response if Dependabot is enabled @@ -57314,8 +57509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -57336,8 +57531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -57357,8 +57552,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *342 - - *343 + - *344 + - *345 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -57396,7 +57591,7 @@ paths: - url protected: type: boolean - protection: &408 + protection: &410 title: Branch Protection description: Branch Protection type: object @@ -57438,7 +57633,7 @@ paths: required: - contexts - checks - enforce_admins: &411 + enforce_admins: &413 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -57453,7 +57648,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &413 + required_pull_request_reviews: &415 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -57474,7 +57669,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *195 + items: *197 apps: description: The list of apps with review dismissal access. @@ -57503,7 +57698,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *195 + items: *197 apps: description: The list of apps allowed to bypass pull request requirements. @@ -57529,7 +57724,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &410 + restrictions: &412 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -57592,7 +57787,7 @@ paths: type: string teams: type: array - items: *195 + items: *197 apps: type: array items: @@ -57788,7 +57983,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -57806,9 +58001,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *342 - - *343 - - &409 + - *344 + - *345 + - &411 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -57822,14 +58017,14 @@ paths: description: Response content: application/json: - schema: &419 + schema: &421 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &476 + commit: &478 title: Commit description: Commit type: object @@ -57863,7 +58058,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &407 + properties: &409 name: type: string example: '"Chris Wanstrath"' @@ -57879,7 +58074,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *409 nullable: true message: type: string @@ -57900,7 +58095,7 @@ paths: required: - sha - url - verification: &531 + verification: &533 title: Verification type: object properties: @@ -57934,12 +58129,12 @@ paths: nullable: true oneOf: - *4 - - *168 + - *170 committer: nullable: true oneOf: - *4 - - *168 + - *170 parents: type: array items: @@ -57970,7 +58165,7 @@ paths: type: integer files: type: array - items: &489 + items: &491 title: Diff Entry description: Diff Entry type: object @@ -58054,7 +58249,7 @@ paths: - self protected: type: boolean - protection: *408 + protection: *410 protection_url: type: string format: uri @@ -58161,7 +58356,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *346 + '301': *348 '404': *6 x-github: githubCloudOnly: false @@ -58183,15 +58378,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *408 + schema: *410 examples: default: value: @@ -58385,9 +58580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -58642,7 +58837,7 @@ paths: url: type: string format: uri - required_status_checks: &416 + required_status_checks: &418 title: Status Check Policy description: Status Check Policy type: object @@ -58718,7 +58913,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 apps: type: array items: *5 @@ -58736,7 +58931,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 apps: type: array items: *5 @@ -58794,7 +58989,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *410 + restrictions: *412 required_conversation_resolution: type: object properties: @@ -58906,9 +59101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -58933,17 +59128,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *411 + schema: *413 examples: - default: &412 + default: &414 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -58965,17 +59160,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *411 + schema: *413 examples: - default: *412 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58994,9 +59189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59021,17 +59216,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *413 + schema: *415 examples: - default: &414 + default: &416 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -59127,9 +59322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -59227,9 +59422,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *415 examples: - default: *414 + default: *416 '422': *15 x-github: githubCloudOnly: false @@ -59250,9 +59445,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59279,17 +59474,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *411 + schema: *413 examples: - default: &415 + default: &417 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -59312,17 +59507,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *411 + schema: *413 examples: - default: *415 + default: *417 '404': *6 x-github: githubCloudOnly: false @@ -59342,9 +59537,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59369,17 +59564,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *416 + schema: *418 examples: - default: &417 + default: &419 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -59405,9 +59600,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -59459,9 +59654,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *418 examples: - default: *417 + default: *419 '404': *6 '422': *15 x-github: @@ -59483,9 +59678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59509,9 +59704,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response @@ -59545,9 +59740,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -59614,9 +59809,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -59680,9 +59875,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: content: application/json: @@ -59748,15 +59943,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response content: application/json: - schema: *410 + schema: *412 examples: default: value: @@ -59847,9 +60042,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '204': description: Response @@ -59872,9 +60067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response @@ -59884,7 +60079,7 @@ paths: type: array items: *5 examples: - default: &418 + default: &420 value: - id: 1 slug: octoapp @@ -59941,9 +60136,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -59977,7 +60172,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *420 '422': *15 x-github: githubCloudOnly: false @@ -59998,9 +60193,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60034,7 +60229,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *420 '422': *15 x-github: githubCloudOnly: false @@ -60055,9 +60250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60091,7 +60286,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *420 '422': *15 x-github: githubCloudOnly: false @@ -60113,9 +60308,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response @@ -60123,9 +60318,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 '404': *6 x-github: githubCloudOnly: false @@ -60145,9 +60340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -60183,9 +60378,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 '422': *15 x-github: githubCloudOnly: false @@ -60206,9 +60401,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: false content: @@ -60244,9 +60439,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 '422': *15 x-github: githubCloudOnly: false @@ -60267,9 +60462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: content: application/json: @@ -60304,9 +60499,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 '422': *15 x-github: githubCloudOnly: false @@ -60328,9 +60523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 responses: '200': description: Response @@ -60340,7 +60535,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '404': *6 x-github: githubCloudOnly: false @@ -60364,9 +60559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60399,7 +60594,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -60424,9 +60619,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60459,7 +60654,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -60484,9 +60679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60519,7 +60714,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -60546,9 +60741,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 requestBody: required: true content: @@ -60570,7 +60765,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *421 examples: default: value: @@ -60686,8 +60881,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -60966,7 +61161,7 @@ paths: description: Response content: application/json: - schema: &420 + schema: &422 title: CheckRun description: A check performed on the code of a given code change type: object @@ -61077,16 +61272,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *91 - deployment: &745 + items: *93 + deployment: &747 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -61153,8 +61348,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -61366,9 +61561,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *342 - - *343 - - &421 + - *344 + - *345 + - &423 name: check_run_id description: The unique identifier of the check run. in: path @@ -61380,9 +61575,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *422 examples: - default: &422 + default: &424 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -61482,9 +61677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *342 - - *343 - - *421 + - *344 + - *345 + - *423 requestBody: required: true content: @@ -61724,9 +61919,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *422 examples: - default: *422 + default: *424 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61746,9 +61941,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *342 - - *343 - - *421 + - *344 + - *345 + - *423 - *17 - *19 responses: @@ -61823,7 +62018,7 @@ paths: raw_details: Do you mean 'bananas' or 'banana'? blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61843,15 +62038,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *342 - - *343 - - *421 + - *344 + - *345 + - *423 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -61889,8 +62084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -61912,7 +62107,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &425 + schema: &427 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -61976,7 +62171,7 @@ paths: nullable: true pull_requests: type: array - items: *91 + items: *93 nullable: true app: title: GitHub app @@ -61987,9 +62182,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - repository: *159 + properties: *83 + required: *84 + repository: *161 created_at: type: string format: date-time @@ -61998,12 +62193,12 @@ paths: type: string format: date-time nullable: true - head_commit: &773 + head_commit: &775 title: Simple Commit description: A commit. type: object - properties: *423 - required: *424 + properties: *425 + required: *426 latest_check_runs_count: type: integer check_runs_url: @@ -62031,7 +62226,7 @@ paths: - check_runs_url - pull_requests examples: - default: &426 + default: &428 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -62322,9 +62517,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *425 + schema: *427 examples: - default: *426 + default: *428 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62343,8 +62538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -62405,7 +62600,7 @@ paths: required: - app_id - setting - repository: *159 + repository: *161 examples: default: value: @@ -62653,9 +62848,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *342 - - *343 - - &427 + - *344 + - *345 + - &429 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -62667,9 +62862,9 @@ paths: description: Response content: application/json: - schema: *425 + schema: *427 examples: - default: *426 + default: *428 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62692,17 +62887,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *342 - - *343 - - *427 - - &482 + - *344 + - *345 + - *429 + - &484 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &483 + - &485 name: status description: Returns check runs with the specified `status`. in: query @@ -62741,9 +62936,9 @@ paths: type: integer check_runs: type: array - items: *420 + items: *422 examples: - default: &484 + default: &486 value: total_count: 1 check_runs: @@ -62825,7 +63020,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62845,15 +63040,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *342 - - *343 - - *427 + - *344 + - *345 + - *429 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -62880,21 +63075,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *342 - - *343 - - *428 - - *429 + - *344 + - *345 + - *430 + - *431 - *19 - *17 - - &446 + - &448 name: ref 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`. in: query required: false - schema: *430 - - &447 + schema: *432 + - &449 name: pr description: The number of the pull request for the results you want to list. in: query @@ -62919,13 +63114,13 @@ paths: be returned. in: query required: false - schema: *431 + schema: *433 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *432 + schema: *434 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -62944,14 +63139,14 @@ paths: items: type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: *433 - state: *186 - fixed_at: *182 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: *435 + state: *188 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -62959,12 +63154,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: *434 - dismissed_comment: *435 - rule: *436 - tool: *437 - most_recent_instance: *438 + dismissed_at: *185 + dismissed_reason: *436 + dismissed_comment: *437 + rule: *438 + tool: *439 + most_recent_instance: *440 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -63090,14 +63285,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &439 + '403': &441 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63117,9 +63312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *342 - - *343 - - &440 + - *344 + - *345 + - &442 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -63127,23 +63322,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *177 + schema: *179 responses: '200': description: Response content: application/json: - schema: &441 + schema: &443 type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: *433 - state: *186 - fixed_at: *182 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: *435 + state: *188 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -63151,9 +63346,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: *434 - dismissed_comment: *435 + dismissed_at: *185 + dismissed_reason: *436 + dismissed_comment: *437 rule: type: object properties: @@ -63207,8 +63402,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *437 - most_recent_instance: *438 + tool: *439 + most_recent_instance: *440 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -63307,9 +63502,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63327,9 +63522,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 requestBody: required: true content: @@ -63344,8 +63539,8 @@ paths: enum: - open - dismissed - dismissed_reason: *434 - dismissed_comment: *435 + dismissed_reason: *436 + dismissed_comment: *437 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -63373,7 +63568,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *443 examples: default: value: @@ -63449,14 +63644,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &445 + '403': &447 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63476,15 +63671,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 responses: '200': description: Response content: application/json: - schema: &442 + schema: &444 type: object properties: status: @@ -63510,13 +63705,13 @@ paths: - description - started_at examples: - default: &443 + default: &445 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &444 + '400': &446 description: Bad Request content: application/json: @@ -63527,9 +63722,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63552,29 +63747,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 responses: '200': description: OK content: application/json: - schema: *442 + schema: *444 examples: - default: *443 + default: *445 '202': description: Accepted content: application/json: - schema: *442 + schema: *444 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *444 + '400': *446 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -63584,7 +63779,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63606,9 +63801,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 requestBody: required: false content: @@ -63653,12 +63848,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *444 - '403': *445 + '400': *446 + '403': *447 '404': *6 '422': description: Unprocessable Entity - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63678,13 +63873,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 - *19 - *17 - - *446 - - *447 + - *448 + - *449 responses: '200': description: Response @@ -63695,10 +63890,10 @@ paths: items: type: object properties: - ref: *430 - analysis_key: *448 - environment: *449 - category: *450 + ref: *432 + analysis_key: *450 + environment: *451 + category: *452 state: type: string description: State of a code scanning alert instance. @@ -63713,7 +63908,7 @@ paths: properties: text: type: string - location: *451 + location: *453 html_url: type: string classifications: @@ -63721,7 +63916,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *452 + items: *454 examples: default: value: @@ -63758,9 +63953,9 @@ paths: end_column: 50 classifications: - source - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63792,25 +63987,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *342 - - *343 - - *428 - - *429 + - *344 + - *345 + - *430 + - *431 - *19 - *17 - - *447 + - *449 - name: ref in: query description: The Git reference for the analyses 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`. required: false - schema: *430 + schema: *432 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &453 + schema: &455 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -63831,23 +64026,23 @@ paths: application/json: schema: type: array - items: &454 + items: &456 type: object properties: - ref: *430 - commit_sha: &462 + ref: *432 + commit_sha: &464 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *448 + analysis_key: *450 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *450 + category: *452 error: type: string example: error reading field xyz @@ -63871,8 +64066,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *453 - tool: *437 + sarif_id: *455 + tool: *439 deletable: type: boolean warning: @@ -63933,9 +64128,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63969,8 +64164,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63983,7 +64178,7 @@ paths: description: Response content: application/json: - schema: *454 + schema: *456 examples: response: summary: application/json response @@ -64037,14 +64232,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *439 + '403': *441 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64124,8 +64319,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64178,9 +64373,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *445 + '403': *447 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64200,8 +64395,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -64209,7 +64404,7 @@ paths: application/json: schema: type: array - items: &455 + items: &457 title: CodeQL Database description: A CodeQL database. type: object @@ -64320,9 +64515,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64349,8 +64544,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: language in: path description: The language of the CodeQL database. @@ -64362,7 +64557,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *457 examples: default: value: @@ -64394,11 +64589,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &493 + '302': &495 description: Found - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64418,8 +64613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *342 - - *343 + - *344 + - *345 - name: language in: path description: The language of the CodeQL database. @@ -64429,9 +64624,9 @@ paths: responses: '204': description: Response - '403': *445 + '403': *447 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64457,8 +64652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -64467,7 +64662,7 @@ paths: type: object additionalProperties: false properties: - language: &456 + language: &458 type: string description: The language targeted by the CodeQL query enum: @@ -64547,7 +64742,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &460 + schema: &462 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -64557,7 +64752,7 @@ paths: description: The ID of the variant analysis. controller_repo: *67 actor: *4 - query_language: *456 + query_language: *458 query_pack_url: type: string description: The download url for the query pack. @@ -64604,7 +64799,7 @@ paths: items: type: object properties: - repository: &457 + repository: &459 title: Repository Identifier description: Repository Identifier type: object @@ -64640,7 +64835,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &461 + analysis_status: &463 type: string description: The new status of the CodeQL variant analysis repository task. @@ -64672,7 +64867,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &458 + access_mismatch_repos: &460 type: object properties: repository_count: @@ -64686,7 +64881,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *457 + items: *459 required: - repository_count - repositories @@ -64708,8 +64903,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *458 - over_limit_repos: *458 + no_codeql_db_repos: *460 + over_limit_repos: *460 required: - access_mismatch_repos - not_found_repos @@ -64725,7 +64920,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &459 + value: &461 summary: Default response value: id: 1 @@ -64871,17 +65066,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *459 + value: *461 repository_lists: summary: Response for a successful variant analysis submission - value: *459 + value: *461 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64902,8 +65097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *342 - - *343 + - *344 + - *345 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -64915,11 +65110,11 @@ paths: description: Response content: application/json: - schema: *460 + schema: *462 examples: - default: *459 + default: *461 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64940,7 +65135,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *342 + - *344 - name: repo in: path description: The name of the controller repository. @@ -64975,7 +65170,7 @@ paths: type: object properties: repository: *67 - analysis_status: *461 + analysis_status: *463 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -65079,7 +65274,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65100,8 +65295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -65184,9 +65379,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *439 + '403': *441 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65205,8 +65400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -65273,7 +65468,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -65298,7 +65493,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *445 + '403': *447 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -65312,7 +65507,7 @@ paths: content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65369,8 +65564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -65378,7 +65573,7 @@ paths: schema: type: object properties: - commit_sha: *462 + commit_sha: *464 ref: type: string description: |- @@ -65436,7 +65631,7 @@ paths: schema: type: object properties: - id: *453 + id: *455 url: type: string description: The REST API URL for checking the status of the upload. @@ -65450,11 +65645,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *445 + '403': *447 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65473,8 +65668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *342 - - *343 + - *344 + - *345 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -65520,10 +65715,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *439 + '403': *441 '404': description: Not Found if the sarif id does not match any upload - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65545,8 +65740,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -65627,8 +65822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *342 - - *343 + - *344 + - *345 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -65748,8 +65943,8 @@ paths: parameters: - *17 - *19 - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -65765,7 +65960,7 @@ paths: type: integer codespaces: type: array - items: *247 + items: *249 examples: default: value: @@ -66063,8 +66258,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -66127,22 +66322,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66166,8 +66361,8 @@ paths: parameters: - *17 - *19 - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -66231,8 +66426,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -66267,14 +66462,14 @@ paths: type: integer machines: type: array - items: &687 + items: &689 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *464 - required: *465 + properties: *466 + required: *467 examples: - default: &688 + default: &690 value: total_count: 2 machines: @@ -66314,8 +66509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *342 - - *343 + - *344 + - *345 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -66399,8 +66594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *342 - - *343 + - *344 + - *345 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -66445,7 +66640,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66466,8 +66661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -66485,7 +66680,7 @@ paths: type: integer secrets: type: array - items: &469 + items: &471 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -66505,9 +66700,9 @@ paths: - created_at - updated_at examples: - default: *466 + default: *468 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66528,16 +66723,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66557,17 +66752,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '200': description: Response content: application/json: - schema: *469 + schema: *471 examples: - default: *470 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66587,9 +66782,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 requestBody: required: true content: @@ -66617,7 +66812,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -66641,9 +66836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '204': description: Response @@ -66671,8 +66866,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *342 - - *343 + - *344 + - *345 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -66714,7 +66909,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &471 + properties: &473 login: type: string example: octocat @@ -66807,7 +67002,7 @@ paths: user_view_type: type: string example: public - required: &472 + required: &474 - avatar_url - events_url - followers_url @@ -66856,7 +67051,7 @@ paths: admin: false role_name: write headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -66881,9 +67076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *342 - - *343 - - *72 + - *344 + - *345 + - *74 responses: '204': description: Response if user is a collaborator @@ -66929,9 +67124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *342 - - *343 - - *72 + - *344 + - *345 + - *74 requestBody: required: false content: @@ -66957,7 +67152,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &544 + schema: &546 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -66968,7 +67163,7 @@ paths: example: 42 type: integer format: int64 - repository: *159 + repository: *161 invitee: title: Simple User description: A GitHub user. @@ -67146,7 +67341,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *128 + schema: *130 '403': *29 x-github: triggersNotification: true @@ -67186,9 +67381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *342 - - *343 - - *72 + - *344 + - *345 + - *74 responses: '204': description: No Content when collaborator was removed from the repository. @@ -67219,9 +67414,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *342 - - *343 - - *72 + - *344 + - *345 + - *74 responses: '200': description: if user has admin permissions @@ -67241,8 +67436,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *471 - required: *472 + properties: *473 + required: *474 nullable: true required: - permission @@ -67297,8 +67492,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -67308,7 +67503,7 @@ paths: application/json: schema: type: array - items: &473 + items: &475 title: Commit Comment description: Commit Comment type: object @@ -67349,8 +67544,8 @@ paths: updated_at: type: string format: date-time - author_association: *83 - reactions: *84 + author_association: *85 + reactions: *86 required: - url - html_url @@ -67366,7 +67561,7 @@ paths: - created_at - updated_at examples: - default: &478 + default: &480 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67400,7 +67595,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67425,17 +67620,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '200': description: Response content: application/json: - schema: *473 + schema: *475 examples: - default: &479 + default: &481 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67492,9 +67687,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -67516,7 +67711,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *475 examples: default: value: @@ -67567,9 +67762,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '204': description: Response @@ -67590,9 +67785,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -67618,7 +67813,7 @@ paths: application/json: schema: type: array - items: &474 + items: &476 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -67661,7 +67856,7 @@ paths: - content - created_at examples: - default: &548 + default: &550 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -67687,7 +67882,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -67706,9 +67901,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -67740,9 +67935,9 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *476 examples: - default: &475 + default: &477 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -67771,9 +67966,9 @@ paths: description: Reaction created content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -67795,10 +67990,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *342 - - *343 - - *102 - - &549 + - *344 + - *345 + - *104 + - &551 name: reaction_id description: The unique identifier of the reaction. in: path @@ -67853,8 +68048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *342 - - *343 + - *344 + - *345 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -67910,9 +68105,9 @@ paths: application/json: schema: type: array - items: *476 + items: *478 examples: - default: &600 + default: &602 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67982,7 +68177,7 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *68 + Link: *70 '500': *55 '400': *14 '404': *6 @@ -68006,9 +68201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *342 - - *343 - - &477 + - *344 + - *345 + - &479 name: commit_sha description: The SHA of the commit. in: path @@ -68080,9 +68275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *342 - - *343 - - *477 + - *344 + - *345 + - *479 - *17 - *19 responses: @@ -68092,11 +68287,11 @@ paths: application/json: schema: type: array - items: *473 + items: *475 examples: - default: *478 + default: *480 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68122,9 +68317,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *342 - - *343 - - *477 + - *344 + - *345 + - *479 requestBody: required: true content: @@ -68159,9 +68354,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *475 examples: - default: *479 + default: *481 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68189,9 +68384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *342 - - *343 - - *477 + - *344 + - *345 + - *479 - *17 - *19 responses: @@ -68201,9 +68396,9 @@ paths: application/json: schema: type: array - items: *480 + items: *482 examples: - default: &592 + default: &594 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -68682,7 +68877,7 @@ paths: auto_merge: draft: false headers: - Link: *68 + Link: *70 '409': *54 x-github: githubCloudOnly: false @@ -68740,11 +68935,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *342 - - *343 + - *344 + - *345 - *19 - *17 - - &481 + - &483 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -68759,9 +68954,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *478 examples: - default: &579 + default: &581 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -68849,7 +69044,7 @@ paths: schema: type: string examples: - default: &490 + default: &492 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -68862,7 +69057,7 @@ paths: schema: type: string examples: - default: &491 + default: &493 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -68889,7 +69084,7 @@ paths: '422': *15 '404': *6 '500': *55 - '503': *120 + '503': *122 '409': *54 x-github: githubCloudOnly: false @@ -68915,11 +69110,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *342 - - *343 - - *481 - - *482 + - *344 + - *345 - *483 + - *484 + - *485 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -68953,11 +69148,11 @@ paths: type: integer check_runs: type: array - items: *420 + items: *422 examples: - default: *484 + default: *486 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68980,9 +69175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *342 - - *343 - - *481 + - *344 + - *345 + - *483 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -68990,7 +69185,7 @@ paths: schema: type: integer example: 1 - - *482 + - *484 - *17 - *19 responses: @@ -69008,7 +69203,7 @@ paths: type: integer check_suites: type: array - items: *425 + items: *427 examples: default: value: @@ -69183,7 +69378,7 @@ paths: latest_check_runs_count: 1 check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69208,9 +69403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *342 - - *343 - - *481 + - *344 + - *345 + - *483 - *17 - *19 responses: @@ -69277,7 +69472,7 @@ paths: type: string total_count: type: integer - repository: *159 + repository: *161 commit_url: type: string format: uri @@ -69408,9 +69603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *342 - - *343 - - *481 + - *344 + - *345 + - *483 - *17 - *19 responses: @@ -69420,7 +69615,7 @@ paths: application/json: schema: type: array - items: &668 + items: &670 title: Status description: The status of a commit. type: object @@ -69500,8 +69695,8 @@ paths: type: User site_admin: false headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69529,8 +69724,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -69559,20 +69754,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *485 - required: *486 + properties: *487 + required: *488 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &487 + properties: &489 url: type: string format: uri html_url: type: string format: uri - required: &488 + required: &490 - url - html_url nullable: true @@ -69580,32 +69775,32 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true contributing: title: Community Health File type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true readme: title: Community Health File type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true issue_template: title: Community Health File type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true pull_request_template: title: Community Health File type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true required: - code_of_conduct @@ -69732,8 +69927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *342 - - *343 + - *344 + - *345 - *19 - *17 - name: basehead @@ -69776,8 +69971,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *476 - merge_base_commit: *476 + base_commit: *478 + merge_base_commit: *478 status: type: string enum: @@ -69797,10 +69992,10 @@ paths: example: 6 commits: type: array - items: *476 + items: *478 files: type: array - items: *489 + items: *491 required: - url - html_url @@ -70046,15 +70241,15 @@ paths: schema: type: string examples: - default: *490 + default: *492 application/vnd.github.patch: schema: type: string examples: - default: *491 + default: *493 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70096,8 +70291,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *342 - - *343 + - *344 + - *345 - name: path description: path parameter in: path @@ -70257,7 +70452,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &492 + response-if-content-is-a-file-github-object: &494 summary: Response if content is a file value: type: file @@ -70389,7 +70584,7 @@ paths: - size - type - url - - &605 + - &607 title: Content File description: Content File type: object @@ -70590,7 +70785,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *492 + response-if-content-is-a-file: *494 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -70659,7 +70854,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *493 + '302': *495 '304': *37 x-github: githubCloudOnly: false @@ -70682,8 +70877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *342 - - *343 + - *344 + - *345 - name: path description: path parameter in: path @@ -70776,7 +70971,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &496 title: File Commit description: File Commit type: object @@ -70928,7 +71123,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *496 examples: example-for-creating-a-file: value: @@ -70982,7 +71177,7 @@ paths: schema: oneOf: - *3 - - &526 + - &528 description: Repository rule violation was detected type: object properties: @@ -71003,7 +71198,7 @@ paths: items: type: object properties: - placeholder_id: &660 + placeholder_id: &662 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -71035,8 +71230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *342 - - *343 + - *344 + - *345 - name: path description: path parameter in: path @@ -71097,7 +71292,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *496 examples: default: value: @@ -71132,7 +71327,7 @@ paths: '422': *15 '404': *6 '409': *54 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71152,8 +71347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *342 - - *343 + - *344 + - *345 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -71253,7 +71448,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *68 + Link: *70 '204': description: Response if repository is empty '403': *29 @@ -71276,24 +71471,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *342 - - *343 - - *197 - - *198 + - *344 + - *345 - *199 - *200 - *201 + - *202 + - *203 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *202 - - *495 - - *203 - *204 + - *497 - *205 + - *206 + - *207 - *62 - *47 - *48 @@ -71305,11 +71500,11 @@ paths: application/json: schema: type: array - items: &499 + items: &501 type: object description: A Dependabot alert. properties: - number: *177 + number: *179 state: type: string description: The state of the Dependabot alert. @@ -71352,13 +71547,13 @@ paths: - direct - transitive - inconclusive - security_advisory: *496 + security_advisory: *498 security_vulnerability: *66 - url: *180 - html_url: *181 - created_at: *178 - updated_at: *179 - dismissed_at: *183 + url: *182 + html_url: *183 + created_at: *180 + updated_at: *181 + dismissed_at: *185 dismissed_by: title: Simple User description: A GitHub user. @@ -71382,9 +71577,9 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *182 - auto_dismissed_at: *497 - dismissal_request: *498 + fixed_at: *184 + auto_dismissed_at: *499 + dismissal_request: *500 assignees: type: array description: The users assigned to this alert. @@ -71639,9 +71834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *342 - - *343 - - &500 + - *344 + - *345 + - &502 name: alert_number in: path description: |- @@ -71650,13 +71845,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *177 + schema: *179 responses: '200': description: Response content: application/json: - schema: *499 + schema: *501 examples: default: value: @@ -71788,9 +71983,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *342 - - *343 - - *500 + - *344 + - *345 + - *502 requestBody: required: true content: @@ -71846,7 +72041,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *501 examples: default: value: @@ -71976,8 +72171,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -71995,7 +72190,7 @@ paths: type: integer secrets: type: array - items: &503 + items: &505 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -72026,7 +72221,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72048,16 +72243,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *501 + schema: *503 examples: - default: *502 + default: *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72077,15 +72272,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '200': description: Response content: application/json: - schema: *503 + schema: *505 examples: default: value: @@ -72111,9 +72306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 requestBody: required: true content: @@ -72141,7 +72336,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -72165,9 +72360,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *342 - - *343 - - *167 + - *344 + - *345 + - *169 responses: '204': description: Response @@ -72189,8 +72384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *342 - - *343 + - *344 + - *345 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -72326,7 +72521,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *68 + Link: *70 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -72350,8 +72545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -72567,7 +72762,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *68 + Link: *70 '404': *6 '403': *29 x-github: @@ -72589,8 +72784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: sbom_uuid in: path required: true @@ -72601,7 +72796,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *504 + Location: *506 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -72622,8 +72817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '201': description: Response @@ -72661,8 +72856,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -72737,7 +72932,7 @@ paths: - version - url additionalProperties: false - metadata: &505 + metadata: &507 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -72770,7 +72965,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *505 + metadata: *507 resolved: type: object description: A collection of resolved package dependencies. @@ -72783,7 +72978,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *505 + metadata: *507 relationship: type: string description: A notation of whether a dependency is requested @@ -72912,8 +73107,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *342 - - *343 + - *344 + - *345 - name: sha description: The SHA recorded at creation time. in: query @@ -72953,11 +73148,11 @@ paths: application/json: schema: type: array - items: *506 + items: *508 examples: - default: *507 + default: *509 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73021,8 +73216,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -73103,7 +73298,7 @@ paths: description: Response content: application/json: - schema: *506 + schema: *508 examples: simple-example: summary: Simple example @@ -73176,9 +73371,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *342 - - *343 - - &508 + - *344 + - *345 + - &510 name: deployment_id description: deployment_id parameter in: path @@ -73190,7 +73385,7 @@ paths: description: Response content: application/json: - schema: *506 + schema: *508 examples: default: value: @@ -73255,9 +73450,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *342 - - *343 - - *508 + - *344 + - *345 + - *510 responses: '204': description: Response @@ -73279,9 +73474,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *342 - - *343 - - *508 + - *344 + - *345 + - *510 - *17 - *19 responses: @@ -73291,7 +73486,7 @@ paths: application/json: schema: type: array - items: &509 + items: &511 title: Deployment Status description: The status of a deployment. type: object @@ -73382,8 +73577,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -73432,7 +73627,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -73452,9 +73647,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *342 - - *343 - - *508 + - *344 + - *345 + - *510 requestBody: required: true content: @@ -73529,9 +73724,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *511 examples: - default: &510 + default: &512 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -73587,9 +73782,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *342 - - *343 - - *508 + - *344 + - *345 + - *510 - name: status_id in: path required: true @@ -73600,9 +73795,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *511 examples: - default: *510 + default: *512 '404': *6 x-github: githubCloudOnly: false @@ -73627,8 +73822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -73685,8 +73880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -73703,7 +73898,7 @@ paths: type: integer environments: type: array - items: &512 + items: &514 title: Environment description: Details of a deployment environment type: object @@ -73755,7 +73950,7 @@ paths: type: type: string example: wait_timer - wait_timer: &514 + wait_timer: &516 type: integer example: 30 description: The amount of time to delay a job after @@ -73792,11 +73987,11 @@ paths: items: type: object properties: - type: *511 + type: *513 reviewer: anyOf: - *4 - - *195 + - *197 required: - id - node_id @@ -73816,7 +74011,7 @@ paths: - id - node_id - type - deployment_branch_policy: &515 + deployment_branch_policy: &517 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -73932,9 +74127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *342 - - *343 - - &513 + - *344 + - *345 + - &515 name: environment_name in: path required: true @@ -73947,9 +74142,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *514 examples: - default: &516 + default: &518 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -74033,9 +74228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 requestBody: required: false content: @@ -74044,7 +74239,7 @@ paths: type: object nullable: true properties: - wait_timer: *514 + wait_timer: *516 prevent_self_review: type: boolean example: false @@ -74061,13 +74256,13 @@ paths: items: type: object properties: - type: *511 + type: *513 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *515 + deployment_branch_policy: *517 additionalProperties: false examples: default: @@ -74087,9 +74282,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *514 examples: - default: *516 + default: *518 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -74113,9 +74308,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 responses: '204': description: Default response @@ -74140,9 +74335,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 - *17 - *19 responses: @@ -74160,7 +74355,7 @@ paths: example: 2 branch_policies: type: array - items: &517 + items: &519 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -74217,9 +74412,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 requestBody: required: true content: @@ -74265,9 +74460,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *519 examples: - example-wildcard: &518 + example-wildcard: &520 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -74309,10 +74504,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *342 - - *343 - - *513 - - &519 + - *344 + - *345 + - *515 + - &521 name: branch_policy_id in: path required: true @@ -74324,9 +74519,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *519 examples: - default: *518 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74345,10 +74540,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *342 - - *343 - - *513 - - *519 + - *344 + - *345 + - *515 + - *521 requestBody: required: true content: @@ -74376,9 +74571,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *519 examples: - default: *518 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74397,10 +74592,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *342 - - *343 - - *513 - - *519 + - *344 + - *345 + - *515 + - *521 responses: '204': description: Response @@ -74425,9 +74620,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *513 - - *343 - - *342 + - *515 + - *345 + - *344 responses: '200': description: List of deployment protection rules @@ -74443,7 +74638,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &520 + items: &522 title: Deployment protection rule description: Deployment protection rule type: object @@ -74462,7 +74657,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &521 + app: &523 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -74561,9 +74756,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *513 - - *343 - - *342 + - *515 + - *345 + - *344 requestBody: content: application/json: @@ -74584,9 +74779,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *520 + schema: *522 examples: - default: &522 + default: &524 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -74621,9 +74816,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *513 - - *343 - - *342 + - *515 + - *345 + - *344 - *19 - *17 responses: @@ -74642,7 +74837,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *521 + items: *523 examples: default: value: @@ -74677,10 +74872,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *342 - - *343 - - *513 - - &523 + - *344 + - *345 + - *515 + - &525 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -74692,9 +74887,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *522 examples: - default: *522 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74715,10 +74910,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *513 - - *343 - - *342 - - *523 + - *515 + - *345 + - *344 + - *525 responses: '204': description: Response @@ -74744,9 +74939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 - *17 - *19 responses: @@ -74764,11 +74959,11 @@ paths: type: integer secrets: type: array - items: *387 + items: *389 examples: - default: *388 + default: *390 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74791,17 +74986,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 responses: '200': description: Response content: application/json: - schema: *389 + schema: *391 examples: - default: *390 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74823,18 +75018,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *342 - - *343 - - *513 - - *167 + - *344 + - *345 + - *515 + - *169 responses: '200': description: Response content: application/json: - schema: *387 + schema: *389 examples: - default: *524 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74856,10 +75051,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *342 - - *343 - - *513 - - *167 + - *344 + - *345 + - *515 + - *169 requestBody: required: true content: @@ -74890,7 +75085,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -74916,10 +75111,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *342 - - *343 - - *513 - - *167 + - *344 + - *345 + - *515 + - *169 responses: '204': description: Default response @@ -74944,10 +75139,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *342 - - *343 - - *513 - - *358 + - *344 + - *345 + - *515 + - *360 - *19 responses: '200': @@ -74964,11 +75159,11 @@ paths: type: integer variables: type: array - items: *391 + items: *393 examples: - default: *392 + default: *394 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74989,9 +75184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *342 - - *343 - - *513 + - *344 + - *345 + - *515 requestBody: required: true content: @@ -75018,7 +75213,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -75043,18 +75238,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *342 - - *343 - - *513 - - *170 + - *344 + - *345 + - *515 + - *172 responses: '200': description: Response content: application/json: - schema: *391 + schema: *393 examples: - default: *525 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75075,10 +75270,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *342 - - *343 - - *170 - - *513 + - *344 + - *345 + - *172 + - *515 requestBody: required: true content: @@ -75120,10 +75315,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *342 - - *343 - - *170 - - *513 + - *344 + - *345 + - *172 + - *515 responses: '204': description: Response @@ -75145,8 +75340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -75156,7 +75351,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: 200-response: value: @@ -75214,8 +75409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *342 - - *343 + - *344 + - *345 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -75237,7 +75432,7 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: default: value: @@ -75350,7 +75545,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *68 + Link: *70 '400': *14 x-github: githubCloudOnly: false @@ -75374,8 +75569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -75407,9 +75602,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 + default: *349 '400': *14 '422': *15 '403': *29 @@ -75430,8 +75625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -75490,8 +75685,8 @@ paths: application/json: schema: oneOf: - - *128 - - *526 + - *130 + - *528 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75516,8 +75711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *342 - - *343 + - *344 + - *345 - name: file_sha in: path required: true @@ -75616,8 +75811,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -75726,7 +75921,7 @@ paths: description: Response content: application/json: - schema: &527 + schema: &529 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -75940,15 +76135,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *342 - - *343 - - *477 + - *344 + - *345 + - *479 responses: '200': description: Response content: application/json: - schema: *527 + schema: *529 examples: default: value: @@ -76004,9 +76199,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *342 - - *343 - - &528 + - *344 + - *345 + - &530 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -76023,7 +76218,7 @@ paths: application/json: schema: type: array - items: &529 + items: &531 title: Git Reference description: Git references within a repository type: object @@ -76076,7 +76271,7 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *68 + Link: *70 '409': *54 x-github: githubCloudOnly: false @@ -76098,17 +76293,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *342 - - *343 - - *528 + - *344 + - *345 + - *530 responses: '200': description: Response content: application/json: - schema: *529 + schema: *531 examples: - default: &530 + default: &532 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -76137,8 +76332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -76167,9 +76362,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *531 examples: - default: *530 + default: *532 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -76195,9 +76390,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *342 - - *343 - - *528 + - *344 + - *345 + - *530 requestBody: required: true content: @@ -76226,9 +76421,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *531 examples: - default: *530 + default: *532 '422': *15 '409': *54 x-github: @@ -76246,9 +76441,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *342 - - *343 - - *528 + - *344 + - *345 + - *530 responses: '204': description: Response @@ -76303,8 +76498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -76371,7 +76566,7 @@ paths: description: Response content: application/json: - schema: &532 + schema: &534 title: Git Tag description: Metadata for a Git tag type: object @@ -76422,7 +76617,7 @@ paths: - sha - type - url - verification: *531 + verification: *533 required: - sha - url @@ -76432,7 +76627,7 @@ paths: - tag - message examples: - default: &533 + default: &535 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -76505,8 +76700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *342 - - *343 + - *344 + - *345 - name: tag_sha in: path required: true @@ -76517,9 +76712,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *534 examples: - default: *533 + default: *535 '404': *6 '409': *54 x-github: @@ -76543,8 +76738,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -76617,7 +76812,7 @@ paths: description: Response content: application/json: - schema: &534 + schema: &536 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -76713,8 +76908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *342 - - *343 + - *344 + - *345 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -76737,7 +76932,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *536 examples: default-response: summary: Default response @@ -76796,8 +76991,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -76807,7 +77002,7 @@ paths: application/json: schema: type: array - items: &535 + items: &537 title: Webhook description: Webhooks for repositories. type: object @@ -76861,7 +77056,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &781 + last_response: &783 title: Hook Response type: object properties: @@ -76916,7 +77111,7 @@ paths: status: unused message: headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -76935,8 +77130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -76988,9 +77183,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: &536 + default: &538 value: type: Repository id: 12345678 @@ -77038,17 +77233,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '200': description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: *536 + default: *538 '404': *6 x-github: githubCloudOnly: false @@ -77068,9 +77263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 requestBody: required: true content: @@ -77115,9 +77310,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: *536 + default: *538 '422': *15 '404': *6 x-github: @@ -77138,9 +77333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '204': description: Response @@ -77164,9 +77359,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '200': description: Response @@ -77193,9 +77388,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 requestBody: required: false content: @@ -77239,12 +77434,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *342 - - *343 - - *215 - - *17 - - *216 + - *344 + - *345 - *217 + - *17 + - *218 + - *219 responses: '200': description: Response @@ -77252,9 +77447,9 @@ paths: application/json: schema: type: array - items: *218 + items: *220 examples: - default: *219 + default: *221 '400': *14 '422': *15 x-github: @@ -77273,18 +77468,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 - *16 responses: '200': description: Response content: application/json: - schema: *220 + schema: *222 examples: - default: *221 + default: *223 '400': *14 '422': *15 x-github: @@ -77303,9 +77498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 - *16 responses: '202': *39 @@ -77328,9 +77523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '204': description: Response @@ -77355,9 +77550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *342 - - *343 - - *215 + - *344 + - *345 + - *217 responses: '204': description: Response @@ -77380,8 +77575,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response if immutable releases are enabled @@ -77427,8 +77622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': *61 '409': *54 @@ -77448,8 +77643,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': *61 '409': *54 @@ -77506,14 +77701,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &537 + schema: &539 title: Import description: A repository import from an external source. type: object @@ -77612,7 +77807,7 @@ paths: - html_url - authors_url examples: - default: &540 + default: &542 value: vcs: subversion use_lfs: true @@ -77628,7 +77823,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &538 + '503': &540 description: Unavailable due to service under maintenance. content: application/json: @@ -77657,8 +77852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -77706,7 +77901,7 @@ paths: description: Response content: application/json: - schema: *537 + schema: *539 examples: default: value: @@ -77731,7 +77926,7 @@ paths: type: string '422': *15 '404': *6 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77759,8 +77954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -77809,7 +78004,7 @@ paths: description: Response content: application/json: - schema: *537 + schema: *539 examples: example-1: summary: Example 1 @@ -77857,7 +78052,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77880,12 +78075,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77911,9 +78106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *342 - - *343 - - &710 + - *344 + - *345 + - &712 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77927,7 +78122,7 @@ paths: application/json: schema: type: array - items: &539 + items: &541 title: Porter Author description: Porter Author type: object @@ -77981,7 +78176,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78006,8 +78201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *342 - - *343 + - *344 + - *345 - name: author_id in: path required: true @@ -78037,7 +78232,7 @@ paths: description: Response content: application/json: - schema: *539 + schema: *541 examples: default: value: @@ -78050,7 +78245,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78074,8 +78269,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -78116,7 +78311,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78144,8 +78339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -78172,11 +78367,11 @@ paths: description: Response content: application/json: - schema: *537 + schema: *539 examples: - default: *540 + default: *542 '422': *15 - '503': *538 + '503': *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78199,8 +78394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -78208,8 +78403,8 @@ paths: application/json: schema: *22 examples: - default: *541 - '301': *346 + default: *543 + '301': *348 '404': *6 x-github: githubCloudOnly: false @@ -78229,8 +78424,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -78238,12 +78433,12 @@ paths: application/json: schema: anyOf: - - *234 + - *236 - type: object properties: {} additionalProperties: false examples: - default: &543 + default: &545 value: limit: collaborators_only origin: repository @@ -78268,13 +78463,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: application/json: - schema: *542 + schema: *544 examples: default: summary: Example request body @@ -78286,9 +78481,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *236 examples: - default: *543 + default: *545 '409': description: Response x-github: @@ -78310,8 +78505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -78334,8 +78529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -78345,9 +78540,9 @@ paths: application/json: schema: type: array - items: *544 + items: *546 examples: - default: &702 + default: &704 value: - id: 1 repository: @@ -78461,7 +78656,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78478,9 +78673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *342 - - *343 - - *238 + - *344 + - *345 + - *240 requestBody: required: false content: @@ -78509,7 +78704,7 @@ paths: description: Response content: application/json: - schema: *544 + schema: *546 examples: default: value: @@ -78640,9 +78835,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *342 - - *343 - - *238 + - *344 + - *345 + - *240 responses: '204': description: Response @@ -78673,8 +78868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *342 - - *343 + - *344 + - *345 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -78722,7 +78917,7 @@ paths: required: false schema: type: string - - *245 + - *247 - name: sort description: What to sort results by. in: query @@ -78735,7 +78930,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -78745,9 +78940,9 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: &556 + default: &558 value: - id: 1 node_id: MDU6SXNzdWUx @@ -78895,8 +79090,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '422': *15 '404': *6 x-github: @@ -78925,8 +79120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -79001,9 +79196,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: &553 + default: &555 value: id: 1 node_id: MDU6SXNzdWUx @@ -79139,9 +79334,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *120 + '503': *122 '404': *6 - '410': *545 + '410': *547 x-github: triggersNotification: true githubCloudOnly: false @@ -79169,9 +79364,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *342 - - *343 - - *110 + - *344 + - *345 + - *112 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -79181,7 +79376,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -79191,9 +79386,9 @@ paths: application/json: schema: type: array - items: *546 + items: *548 examples: - default: &555 + default: &557 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79224,7 +79419,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '422': *15 '404': *6 x-github: @@ -79251,17 +79446,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '200': description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: &547 + default: &549 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79316,9 +79511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -79340,9 +79535,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: *547 + default: *549 '422': *15 x-github: githubCloudOnly: false @@ -79360,9 +79555,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '204': description: Response @@ -79390,15 +79585,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '200': description: Response content: application/json: - schema: *546 + schema: *548 examples: default: value: @@ -79454,7 +79649,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *545 + '410': *547 '422': *15 x-github: githubCloudOnly: false @@ -79471,17 +79666,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '204': description: Response '401': *25 '403': *29 '404': *6 - '410': *545 - '503': *120 + '410': *547 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79498,9 +79693,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -79526,11 +79721,11 @@ paths: application/json: schema: type: array - items: *474 + items: *476 examples: - default: *548 + default: *550 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -79549,9 +79744,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -79583,16 +79778,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '201': description: Reaction created content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -79614,10 +79809,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *342 - - *343 - - *102 - - *549 + - *344 + - *345 + - *104 + - *551 responses: '204': description: Response @@ -79637,8 +79832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -79648,7 +79843,7 @@ paths: application/json: schema: type: array - items: &552 + items: &554 title: Issue Event description: Issue Event type: object @@ -79691,8 +79886,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *550 - required: *551 + properties: *552 + required: *553 nullable: true label: title: Issue Event Label @@ -79736,7 +79931,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *195 + requested_team: *197 dismissed_review: title: Issue Event Dismissed Review type: object @@ -79801,7 +79996,7 @@ paths: required: - from - to - author_association: *83 + author_association: *85 lock_reason: type: string nullable: true @@ -79814,8 +80009,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -79982,7 +80177,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -80000,8 +80195,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *342 - - *343 + - *344 + - *345 - name: event_id in: path required: true @@ -80012,7 +80207,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *554 examples: default: value: @@ -80205,7 +80400,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *545 + '410': *547 '403': *29 x-github: githubCloudOnly: false @@ -80239,9 +80434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *342 - - *343 - - &554 + - *344 + - *345 + - &556 name: issue_number description: The number that identifies the issue. in: path @@ -80253,11 +80448,11 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: default: summary: Issue - value: *553 + value: *555 pinned_comment: summary: Issue with pinned comment value: @@ -80437,9 +80632,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *346 + '301': *348 '404': *6 - '410': *545 + '410': *547 '304': *37 x-github: githubCloudOnly: false @@ -80464,9 +80659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -80585,15 +80780,15 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 '422': *15 - '503': *120 + '503': *122 '403': *29 - '301': *346 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80611,9 +80806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -80639,9 +80834,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80657,9 +80852,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: content: application/json: @@ -80684,9 +80879,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80708,9 +80903,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - name: assignee in: path required: true @@ -80750,10 +80945,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *342 - - *343 - - *554 - - *93 + - *344 + - *345 + - *556 + - *95 - *17 - *19 responses: @@ -80763,13 +80958,13 @@ paths: application/json: schema: type: array - items: *546 + items: *548 examples: - default: *555 + default: *557 headers: - Link: *68 + Link: *70 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80798,9 +80993,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -80822,16 +81017,16 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: *547 + default: *549 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *545 + '410': *547 '422': *15 '404': *6 x-github: @@ -80859,9 +81054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -80871,14 +81066,14 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *556 + default: *558 headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80906,9 +81101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -80930,17 +81125,17 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *346 + '301': *348 '403': *29 - '410': *545 + '410': *547 '422': *15 '404': *6 x-github: @@ -80971,9 +81166,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -80985,15 +81180,15 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 - '301': *346 + default: *555 + '301': *348 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *545 + '410': *547 x-github: triggersNotification: true githubCloudOnly: false @@ -81019,9 +81214,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -81031,14 +81226,14 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *556 + default: *558 headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81055,9 +81250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -81071,7 +81266,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &560 + - &562 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -81102,8 +81297,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 label: type: object properties: @@ -81125,7 +81320,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &561 + - &563 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -81156,8 +81351,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 label: type: object properties: @@ -81245,8 +81440,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 assigner: *4 required: @@ -81261,7 +81456,7 @@ paths: - performed_via_github_app - assignee - assigner - - &562 + - &564 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -81292,8 +81487,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 milestone: type: object properties: @@ -81312,7 +81507,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &563 + - &565 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -81343,8 +81538,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 milestone: type: object properties: @@ -81363,7 +81558,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &564 + - &566 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -81394,8 +81589,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 rename: type: object properties: @@ -81417,7 +81612,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &567 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -81448,10 +81643,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 review_requester: *4 - requested_team: *195 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -81464,7 +81659,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &568 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -81495,10 +81690,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 review_requester: *4 - requested_team: *195 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -81511,7 +81706,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &569 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -81542,8 +81737,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 dismissed_review: type: object properties: @@ -81571,7 +81766,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &570 title: Locked Issue Event description: Locked Issue Event type: object @@ -81602,8 +81797,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 lock_reason: type: string example: '"off-topic"' @@ -81619,7 +81814,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &569 + - &571 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -81650,8 +81845,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -81685,7 +81880,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &570 + - &572 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -81716,8 +81911,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -81751,7 +81946,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &571 + - &573 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -81782,8 +81977,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -81817,7 +82012,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &572 + - &574 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -81907,8 +82102,8 @@ paths: name: label color: red headers: - Link: *68 - '410': *545 + Link: *70 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81925,9 +82120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -81937,9 +82132,9 @@ paths: application/json: schema: type: array - items: *557 + items: *559 examples: - default: &558 + default: &560 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -81962,10 +82157,10 @@ paths: data_type: date value: '2025-12-25' headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81994,9 +82189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -82060,14 +82255,14 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *557 + items: *559 examples: - default: *558 + default: *560 '400': *14 '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -82098,9 +82293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -82165,14 +82360,14 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *557 + items: *559 examples: - default: *558 + default: *560 '400': *14 '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -82198,17 +82393,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *342 - - *343 - - *554 - - *241 + - *344 + - *345 + - *556 + - *243 responses: '204': description: Issue field value deleted successfully '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -82226,9 +82421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -82238,9 +82433,9 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: &559 + default: &561 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82257,10 +82452,10 @@ paths: color: a2eeef default: false headers: - Link: *68 - '301': *346 + Link: *70 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82276,9 +82471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -82321,12 +82516,12 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *559 - '301': *346 + default: *561 + '301': *348 '404': *6 - '410': *545 + '410': *547 '422': *15 x-github: githubCloudOnly: false @@ -82343,9 +82538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -82405,12 +82600,12 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *559 - '301': *346 + default: *561 + '301': *348 '404': *6 - '410': *545 + '410': *547 '422': *15 x-github: githubCloudOnly: false @@ -82427,15 +82622,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 responses: '204': description: Response - '301': *346 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82454,9 +82649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - name: name in: path required: true @@ -82469,7 +82664,7 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: default: value: @@ -82480,9 +82675,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *346 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82502,9 +82697,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: false content: @@ -82532,7 +82727,7 @@ paths: '204': description: Response '403': *29 - '410': *545 + '410': *547 '404': *6 '422': *15 x-github: @@ -82550,9 +82745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 responses: '204': description: Response @@ -82582,20 +82777,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 responses: '200': description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 - '301': *346 + default: *555 + '301': *348 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82612,9 +82807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -82640,13 +82835,13 @@ paths: application/json: schema: type: array - items: *474 + items: *476 examples: - default: *548 + default: *550 headers: - Link: *68 + Link: *70 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82664,9 +82859,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -82698,16 +82893,16 @@ paths: description: Response content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '201': description: Response content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -82729,10 +82924,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *342 - - *343 - - *554 - - *549 + - *344 + - *345 + - *556 + - *551 responses: '204': description: Response @@ -82761,9 +82956,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -82785,9 +82980,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -82820,9 +83015,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -82832,13 +83027,13 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *556 + default: *558 headers: - Link: *68 + Link: *70 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82866,9 +83061,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -82895,16 +83090,16 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *545 + '410': *547 '422': *15 '404': *6 x-github: @@ -82924,9 +83119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 requestBody: required: true content: @@ -82957,13 +83152,13 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *553 + default: *555 '403': *29 '404': *6 '422': *7 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -82981,9 +83176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *342 - - *343 - - *554 + - *344 + - *345 + - *556 - *17 - *19 responses: @@ -82998,8 +83193,6 @@ paths: description: Timeline Event type: object anyOf: - - *560 - - *561 - *562 - *563 - *564 @@ -83011,6 +83204,8 @@ paths: - *570 - *571 - *572 + - *573 + - *574 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -83053,7 +83248,7 @@ paths: issue_url: type: string format: uri - author_association: *83 + author_association: *85 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -83063,16 +83258,16 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - reactions: *84 + properties: *83 + required: *84 + reactions: *86 pin: title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *573 - required: *574 + properties: *575 + required: *576 nullable: true required: - event @@ -83104,7 +83299,7 @@ paths: properties: type: type: string - issue: *86 + issue: *88 required: - event - created_at @@ -83304,7 +83499,7 @@ paths: type: string body_text: type: string - author_association: *83 + author_association: *85 required: - event - id @@ -83327,7 +83522,7 @@ paths: type: string comments: type: array - items: &594 + items: &596 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -83422,7 +83617,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *83 + author_association: *85 _links: type: object properties: @@ -83506,7 +83701,7 @@ paths: enum: - line - file - reactions: *84 + reactions: *86 body_html: type: string example: '"

comment body

"' @@ -83542,7 +83737,7 @@ paths: type: string comments: type: array - items: *473 + items: *475 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -83573,8 +83768,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 required: - id @@ -83617,8 +83812,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 required: - id @@ -83661,8 +83856,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 state_reason: type: string nullable: true @@ -83829,9 +84024,9 @@ paths: type: User site_admin: true headers: - Link: *68 + Link: *70 '404': *6 - '410': *545 + '410': *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83848,8 +84043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -83859,7 +84054,7 @@ paths: application/json: schema: type: array - items: &575 + items: &577 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -83909,7 +84104,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83925,8 +84120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -83962,9 +84157,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *577 examples: - default: &576 + default: &578 value: id: 1 key: ssh-rsa AAA... @@ -83998,9 +84193,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *342 - - *343 - - &577 + - *344 + - *345 + - &579 name: key_id description: The unique identifier of the key. in: path @@ -84012,9 +84207,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *577 examples: - default: *576 + default: *578 '404': *6 x-github: githubCloudOnly: false @@ -84032,9 +84227,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *342 - - *343 - - *577 + - *344 + - *345 + - *579 responses: '204': description: Response @@ -84054,8 +84249,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -84065,11 +84260,11 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *559 + default: *561 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -84088,8 +84283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -84125,9 +84320,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: - default: &578 + default: &580 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -84159,8 +84354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *342 - - *343 + - *344 + - *345 - name: name in: path required: true @@ -84171,9 +84366,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: - default: *578 + default: *580 '404': *6 x-github: githubCloudOnly: false @@ -84190,8 +84385,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *342 - - *343 + - *344 + - *345 - name: name in: path required: true @@ -84230,7 +84425,7 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: default: value: @@ -84256,8 +84451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *342 - - *343 + - *344 + - *345 - name: name in: path required: true @@ -84283,8 +84478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -84323,9 +84518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *342 - - *343 - - *446 + - *344 + - *345 + - *448 responses: '200': description: Response @@ -84387,8 +84582,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true required: - _links @@ -84470,8 +84665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -84536,8 +84731,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -84571,9 +84766,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *476 + schema: *478 examples: - default: *579 + default: *581 '204': description: Response when already merged '404': @@ -84598,8 +84793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *342 - - *343 + - *344 + - *345 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -84640,12 +84835,12 @@ paths: application/json: schema: type: array - items: &580 + items: &582 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *281 + required: *282 examples: default: value: @@ -84684,7 +84879,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -84701,8 +84896,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -84742,9 +84937,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *582 examples: - default: &581 + default: &583 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -84803,9 +84998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *342 - - *343 - - &582 + - *344 + - *345 + - &584 name: milestone_number description: The number that identifies the milestone. in: path @@ -84817,9 +85012,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *582 examples: - default: *581 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -84836,9 +85031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *342 - - *343 - - *582 + - *344 + - *345 + - *584 requestBody: required: false content: @@ -84876,9 +85071,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *582 examples: - default: *581 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84894,9 +85089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *342 - - *343 - - *582 + - *344 + - *345 + - *584 responses: '204': description: Response @@ -84917,9 +85112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *342 - - *343 - - *582 + - *344 + - *345 + - *584 - *17 - *19 responses: @@ -84929,11 +85124,11 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *559 + default: *561 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84950,12 +85145,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *342 - - *343 - - *583 - - *584 - - *93 + - *344 + - *345 - *585 + - *586 + - *95 + - *587 - *17 - *19 responses: @@ -84965,11 +85160,11 @@ paths: application/json: schema: type: array - items: *113 + items: *115 examples: - default: *586 + default: *588 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -84991,8 +85186,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -85050,14 +85245,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: &587 + schema: &589 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -85182,7 +85377,7 @@ paths: - custom_404 - public examples: - default: &588 + default: &590 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -85223,8 +85418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -85278,9 +85473,9 @@ paths: description: Response content: application/json: - schema: *587 + schema: *589 examples: - default: *588 + default: *590 '422': *15 '409': *54 x-github: @@ -85303,8 +85498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -85403,8 +85598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -85430,8 +85625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -85441,7 +85636,7 @@ paths: application/json: schema: type: array - items: &589 + items: &591 title: Page Build description: Page Build type: object @@ -85516,7 +85711,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85535,8 +85730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *342 - - *343 + - *344 + - *345 responses: '201': description: Response @@ -85581,16 +85776,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *589 + schema: *591 examples: - default: &590 + default: &592 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -85638,8 +85833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *342 - - *343 + - *344 + - *345 - name: build_id in: path required: true @@ -85650,9 +85845,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: - default: *590 + default: *592 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85672,8 +85867,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -85778,9 +85973,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *342 - - *343 - - &591 + - *344 + - *345 + - &593 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -85838,9 +86033,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *342 - - *343 - - *591 + - *344 + - *345 + - *593 responses: '204': *61 '404': *6 @@ -85867,8 +86062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -86099,7 +86294,7 @@ paths: description: Empty response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -86126,8 +86321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Private vulnerability reporting status @@ -86164,8 +86359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': *61 '422': *14 @@ -86186,8 +86381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': *61 '422': *14 @@ -86209,8 +86404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -86218,7 +86413,7 @@ paths: application/json: schema: type: array - items: *294 + items: *296 examples: default: value: @@ -86249,8 +86444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -86262,7 +86457,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *294 + items: *296 required: - properties examples: @@ -86312,8 +86507,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *342 - - *343 + - *344 + - *345 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -86373,11 +86568,11 @@ paths: application/json: schema: type: array - items: *480 + items: *482 examples: - default: *592 + default: *594 headers: - Link: *68 + Link: *70 '304': *37 '422': *15 x-github: @@ -86407,8 +86602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -86473,7 +86668,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &598 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -86584,8 +86779,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *281 + required: *282 nullable: true active_lock_reason: type: string @@ -86617,7 +86812,7 @@ paths: items: *4 requested_teams: type: array - items: *331 + items: *333 head: type: object properties: @@ -86625,7 +86820,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: *4 @@ -86642,7 +86837,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: *4 @@ -86655,14 +86850,14 @@ paths: _links: type: object properties: - comments: *281 - commits: *281 - statuses: *281 - html: *281 - issue: *281 - review_comments: *281 - review_comment: *281 - self: *281 + comments: *283 + commits: *283 + statuses: *283 + html: *283 + issue: *283 + review_comments: *283 + review_comment: *283 + self: *283 required: - comments - commits @@ -86672,8 +86867,8 @@ paths: - review_comments - review_comment - self - author_association: *83 - auto_merge: *593 + author_association: *85 + auto_merge: *595 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -86763,7 +86958,7 @@ paths: - merged_by - review_comments examples: - default: &597 + default: &599 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -87270,8 +87465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *342 - - *343 + - *344 + - *345 - name: sort in: query required: false @@ -87290,7 +87485,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -87300,9 +87495,9 @@ paths: application/json: schema: type: array - items: *594 + items: *596 examples: - default: &599 + default: &601 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87354,7 +87549,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87379,17 +87574,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '200': description: Response content: application/json: - schema: *594 + schema: *596 examples: - default: &595 + default: &597 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87464,9 +87659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -87488,9 +87683,9 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: - default: *595 + default: *597 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87506,9 +87701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 responses: '204': description: Response @@ -87529,9 +87724,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -87557,11 +87752,11 @@ paths: application/json: schema: type: array - items: *474 + items: *476 examples: - default: *548 + default: *550 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -87580,9 +87775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *342 - - *343 - - *102 + - *344 + - *345 + - *104 requestBody: required: true content: @@ -87614,16 +87809,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '201': description: Reaction created content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -87645,10 +87840,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *342 - - *343 - - *102 - - *549 + - *344 + - *345 + - *104 + - *551 responses: '204': description: Response @@ -87691,9 +87886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *342 - - *343 - - &598 + - *344 + - *345 + - &600 name: pull_number description: The number that identifies the pull request. in: path @@ -87706,9 +87901,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *596 + schema: *598 examples: - default: *597 + default: *599 '304': *37 '404': *6 '406': @@ -87717,7 +87912,7 @@ paths: application/json: schema: *3 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87743,9 +87938,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -87787,9 +87982,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *598 examples: - default: *597 + default: *599 '422': *15 '403': *29 x-github: @@ -87811,9 +88006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 responses: '204': description: Response @@ -87838,9 +88033,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 responses: '204': description: Response @@ -87866,9 +88061,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: true content: @@ -87928,21 +88123,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -87968,10 +88163,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *342 - - *343 - - *598 - - *110 + - *344 + - *345 + - *600 + - *112 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -87981,7 +88176,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -87991,11 +88186,11 @@ paths: application/json: schema: type: array - items: *594 + items: *596 examples: - default: *599 + default: *601 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88026,9 +88221,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: true content: @@ -88133,7 +88328,7 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: example-for-a-multi-line-comment: value: @@ -88221,10 +88416,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *342 - - *343 - - *598 - - *102 + - *344 + - *345 + - *600 + - *104 requestBody: required: true content: @@ -88246,7 +88441,7 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: default: value: @@ -88332,9 +88527,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 - *17 - *19 responses: @@ -88344,11 +88539,11 @@ paths: application/json: schema: type: array - items: *476 + items: *478 examples: - default: *600 + default: *602 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88376,9 +88571,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 - *17 - *19 responses: @@ -88388,7 +88583,7 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: default: value: @@ -88404,10 +88599,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *68 + Link: *70 '422': *15 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88426,9 +88621,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 responses: '204': description: Response if pull request has been merged @@ -88451,9 +88646,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -88564,9 +88759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 responses: '200': description: Response @@ -88582,7 +88777,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 required: - users - teams @@ -88623,7 +88818,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88641,9 +88836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -88680,7 +88875,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *482 examples: default: value: @@ -89216,9 +89411,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: true content: @@ -89252,7 +89447,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *482 examples: default: value: @@ -89737,9 +89932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 - *17 - *19 responses: @@ -89749,7 +89944,7 @@ paths: application/json: schema: type: array - items: &601 + items: &603 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -89818,7 +90013,7 @@ paths: type: string body_text: type: string - author_association: *83 + author_association: *85 required: - id - node_id @@ -89867,7 +90062,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89900,9 +90095,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -89988,9 +90183,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: &603 + default: &605 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -90053,10 +90248,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - &602 + - *344 + - *345 + - *600 + - &604 name: review_id description: The unique identifier of the review. in: path @@ -90068,9 +90263,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: &604 + default: &606 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -90129,10 +90324,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 requestBody: required: true content: @@ -90155,7 +90350,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: default: value: @@ -90217,18 +90412,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 responses: '200': description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: *603 + default: *605 '422': *7 '404': *6 x-github: @@ -90255,10 +90450,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 - *17 - *19 responses: @@ -90337,13 +90532,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *83 + author_association: *85 _links: type: object properties: - self: *281 - html: *281 - pull_request: *281 + self: *283 + html: *283 + pull_request: *283 required: - self - html @@ -90352,7 +90547,7 @@ paths: type: string body_html: type: string - reactions: *84 + reactions: *86 side: description: The side of the first line of the range for a multi-line comment. @@ -90464,7 +90659,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -90493,10 +90688,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 requestBody: required: true content: @@ -90524,7 +90719,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: default: value: @@ -90587,10 +90782,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *342 - - *343 - - *598 - - *602 + - *344 + - *345 + - *600 + - *604 requestBody: required: true content: @@ -90625,9 +90820,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: *604 + default: *606 '404': *6 '422': *7 '403': *29 @@ -90649,9 +90844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *342 - - *343 - - *598 + - *344 + - *345 + - *600 requestBody: required: false content: @@ -90714,8 +90909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *342 - - *343 + - *344 + - *345 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -90728,9 +90923,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *607 examples: - default: &606 + default: &608 value: type: file encoding: base64 @@ -90772,8 +90967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *342 - - *343 + - *344 + - *345 - name: dir description: The alternate path to look for a README file in: path @@ -90793,9 +90988,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *607 examples: - default: *606 + default: *608 '404': *6 '422': *15 x-github: @@ -90817,8 +91012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -90828,7 +91023,7 @@ paths: application/json: schema: type: array - items: *607 + items: *609 examples: default: value: @@ -90902,7 +91097,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -90922,8 +91117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -90999,9 +91194,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: &611 + default: &613 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -91106,9 +91301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *342 - - *343 - - &609 + - *344 + - *345 + - &611 name: asset_id description: The unique identifier of the asset. in: path @@ -91120,9 +91315,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: &610 + default: &612 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -91157,7 +91352,7 @@ paths: type: User site_admin: false '404': *6 - '302': *493 + '302': *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91173,9 +91368,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *342 - - *343 - - *609 + - *344 + - *345 + - *611 requestBody: required: false content: @@ -91203,9 +91398,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: *610 + default: *612 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91221,9 +91416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *342 - - *343 - - *609 + - *344 + - *345 + - *611 responses: '204': description: Response @@ -91248,8 +91443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -91334,16 +91529,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': *6 x-github: githubCloudOnly: false @@ -91361,8 +91556,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *342 - - *343 + - *344 + - *345 - name: tag description: tag parameter in: path @@ -91375,9 +91570,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': *6 x-github: githubCloudOnly: false @@ -91399,9 +91594,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *342 - - *343 - - &612 + - *344 + - *345 + - &614 name: release_id description: The unique identifier of the release. in: path @@ -91415,9 +91610,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '401': description: Unauthorized x-github: @@ -91435,9 +91630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 requestBody: required: false content: @@ -91501,9 +91696,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': description: Not Found if the discussion category name is invalid content: @@ -91524,9 +91719,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 responses: '204': description: Response @@ -91547,9 +91742,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 - *17 - *19 responses: @@ -91559,7 +91754,7 @@ paths: application/json: schema: type: array - items: *608 + items: *610 examples: default: value: @@ -91596,7 +91791,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91640,9 +91835,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 - name: name in: query required: true @@ -91668,7 +91863,7 @@ paths: description: Response for successful upload content: application/json: - schema: *608 + schema: *610 examples: response-for-successful-upload: value: @@ -91723,9 +91918,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -91749,11 +91944,11 @@ paths: application/json: schema: type: array - items: *474 + items: *476 examples: - default: *548 + default: *550 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -91772,9 +91967,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *342 - - *343 - - *612 + - *344 + - *345 + - *614 requestBody: required: true content: @@ -91804,16 +91999,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '201': description: Reaction created content: application/json: - schema: *474 + schema: *476 examples: - default: *475 + default: *477 '422': *15 x-github: githubCloudOnly: false @@ -91835,10 +92030,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *342 - - *343 - - *612 - - *549 + - *344 + - *345 + - *614 + - *551 responses: '204': description: Response @@ -91862,9 +92057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *342 - - *343 - - *409 + - *344 + - *345 + - *411 - *17 - *19 responses: @@ -91880,8 +92075,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *303 - - &613 + - *305 + - &615 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -91900,69 +92095,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *304 - - *613 - - allOf: - - *305 - - *613 - allOf: - *306 - - *613 - - allOf: - - *614 - - *613 + - *615 - allOf: - *307 - - *613 + - *615 - allOf: - *308 - - *613 + - *615 + - allOf: + - *616 + - *615 - allOf: - *309 - - *613 + - *615 - allOf: - *310 - - *613 + - *615 - allOf: - *311 - - *613 + - *615 - allOf: - *312 - - *613 + - *615 - allOf: - *313 - - *613 + - *615 - allOf: - *314 - - *613 + - *615 - allOf: - *315 - - *613 + - *615 - allOf: - *316 - - *613 + - *615 - allOf: - *317 - - *613 + - *615 - allOf: - *318 - - *613 + - *615 - allOf: - *319 - - *613 + - *615 - allOf: - *320 - - *613 + - *615 - allOf: - *321 - - *613 + - *615 - allOf: - *322 - - *613 + - *615 - allOf: - *323 - - *613 + - *615 + - allOf: + - *324 + - *615 + - allOf: + - *325 + - *615 examples: default: value: @@ -92001,8 +92196,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 - name: includes_parents @@ -92013,7 +92208,7 @@ paths: schema: type: boolean default: true - - *615 + - *617 responses: '200': description: Response @@ -92021,7 +92216,7 @@ paths: application/json: schema: type: array - items: *324 + items: *326 examples: default: value: @@ -92068,8 +92263,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 requestBody: description: Request body required: true @@ -92089,16 +92284,16 @@ paths: - tag - push default: branch - enforcement: *300 + enforcement: *302 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *298 + items: *303 + conditions: *300 rules: type: array description: An array of rules within the ruleset. - items: *616 + items: *618 required: - name - enforcement @@ -92129,9 +92324,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: &626 + default: &628 value: id: 42 name: super cool ruleset @@ -92179,12 +92374,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *342 - - *343 - - *617 - - *618 + - *344 + - *345 - *619 - *620 + - *621 + - *622 - *17 - *19 responses: @@ -92192,9 +92387,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *623 examples: - default: *622 + default: *624 '404': *6 '500': *55 x-github: @@ -92215,17 +92410,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *342 - - *343 - - *623 + - *344 + - *345 + - *625 responses: '200': description: Response content: application/json: - schema: *624 + schema: *626 examples: - default: *625 + default: *627 '404': *6 '500': *55 x-github: @@ -92253,8 +92448,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92274,9 +92469,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: *626 + default: *628 '404': *6 '500': *55 put: @@ -92294,8 +92489,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92320,16 +92515,16 @@ paths: - branch - tag - push - enforcement: *300 + enforcement: *302 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *298 + items: *303 + conditions: *300 rules: description: An array of rules within the ruleset. type: array - items: *616 + items: *618 examples: default: value: @@ -92357,9 +92552,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *326 examples: - default: *626 + default: *628 '404': *6 '422': *15 '500': *55 @@ -92378,8 +92573,8 @@ paths: category: repos subcategory: rules parameters: - - *342 - - *343 + - *344 + - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92402,8 +92597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 - name: ruleset_id @@ -92419,9 +92614,9 @@ paths: application/json: schema: type: array - items: *327 + items: *329 examples: - default: *627 + default: *629 '404': *6 '500': *55 x-github: @@ -92440,8 +92635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *342 - - *343 + - *344 + - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92459,7 +92654,7 @@ paths: description: Response content: application/json: - schema: *628 + schema: *630 examples: default: value: @@ -92514,25 +92709,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *342 - - *343 - - *629 - - *630 + - *344 + - *345 - *631 - *632 - *633 - *634 - *635 - *636 + - *637 + - *638 - *62 - *19 - *17 - - *637 - - *638 - *639 - *640 - *641 - *642 + - *643 + - *644 responses: '200': description: Response @@ -92540,11 +92735,11 @@ paths: application/json: schema: type: array - items: &646 + items: &648 type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -92552,15 +92747,15 @@ paths: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *643 - resolution: *644 + state: *645 + resolution: *646 resolved_at: type: string format: date-time @@ -92666,7 +92861,7 @@ paths: pull request. ' - oneOf: *645 + oneOf: *647 nullable: true has_more_locations: type: boolean @@ -92808,7 +93003,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92830,16 +93025,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *342 - - *343 - - *440 - - *642 + - *344 + - *345 + - *442 + - *644 responses: '200': description: Response content: application/json: - schema: *646 + schema: *648 examples: default: value: @@ -92870,7 +93065,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92893,9 +93088,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 requestBody: required: true content: @@ -92903,8 +93098,8 @@ paths: schema: type: object properties: - state: *643 - resolution: *644 + state: *645 + resolution: *646 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -92915,6 +93110,14 @@ paths: to `null` to unassign the alert. type: string nullable: true + validity: + type: string + nullable: true + enum: + - active + - inactive + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -92940,7 +93143,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *648 examples: default: value: @@ -93012,8 +93215,9 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository - '503': *120 + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -93035,9 +93239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *342 - - *343 - - *440 + - *344 + - *345 + - *442 - *19 - *17 responses: @@ -93048,7 +93252,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &803 + items: &805 type: object properties: type: @@ -93074,8 +93278,6 @@ paths: example: commit details: oneOf: - - *647 - - *648 - *649 - *650 - *651 @@ -93087,6 +93289,8 @@ paths: - *657 - *658 - *659 + - *660 + - *661 examples: default: value: @@ -93146,11 +93350,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *68 + Link: *70 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93172,8 +93376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -93181,14 +93385,14 @@ paths: schema: type: object properties: - reason: &661 + reason: &663 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *660 + placeholder_id: *662 required: - reason - placeholder_id @@ -93205,7 +93409,7 @@ paths: schema: type: object properties: - reason: *661 + reason: *663 expire_at: type: string format: date-time @@ -93228,7 +93432,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -93251,13 +93455,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *120 + '503': *122 '200': description: Response content: @@ -93267,7 +93471,7 @@ paths: properties: incremental_scans: type: array - items: &662 + items: &664 description: Information on a single scan performed by secret scanning on the repository type: object @@ -93293,15 +93497,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *662 + items: *664 backfill_scans: type: array - items: *662 + items: *664 custom_pattern_backfill_scans: type: array items: allOf: - - *662 + - *664 - type: object properties: pattern_name: @@ -93314,7 +93518,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *662 + items: *664 examples: default: value: @@ -93379,8 +93583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *342 - - *343 + - *344 + - *345 - *62 - name: sort description: The property to sort the results by. @@ -93424,9 +93628,9 @@ paths: application/json: schema: type: array - items: *663 + items: *665 examples: - default: *664 + default: *666 '400': *14 '404': *6 x-github: @@ -93449,8 +93653,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -93523,7 +93727,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *332 required: - login - type @@ -93610,9 +93814,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *665 examples: - default: &666 + default: &668 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -93842,8 +94046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -93947,7 +94151,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *665 examples: default: value: @@ -94093,17 +94297,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *342 - - *343 - - *665 + - *344 + - *345 + - *667 responses: '200': description: Response content: application/json: - schema: *663 + schema: *665 examples: - default: *666 + default: *668 '403': *29 '404': *6 x-github: @@ -94127,9 +94331,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *342 - - *343 - - *665 + - *344 + - *345 + - *667 requestBody: required: true content: @@ -94202,7 +94406,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *332 required: - login - type @@ -94288,17 +94492,17 @@ paths: description: Response content: application/json: - schema: *663 + schema: *665 examples: - default: *666 - add_credit: *666 + default: *668 + add_credit: *668 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *128 + schema: *130 examples: invalid_state_transition: value: @@ -94329,9 +94533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *342 - - *343 - - *665 + - *344 + - *345 + - *667 responses: '202': *39 '400': *14 @@ -94358,17 +94562,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *342 - - *343 - - *665 + - *344 + - *345 + - *667 responses: '202': description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 + default: *349 '400': *14 '422': *15 '403': *29 @@ -94394,8 +94598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -94472,7 +94676,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -94494,8 +94698,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -94504,7 +94708,7 @@ paths: application/json: schema: type: array - items: &667 + items: &669 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -94537,8 +94741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -94614,8 +94818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -94711,8 +94915,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -94866,8 +95070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -94877,7 +95081,7 @@ paths: application/json: schema: type: array - items: *667 + items: *669 examples: default: value: @@ -94910,8 +95114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *342 - - *343 + - *344 + - *345 - name: sha in: path required: true @@ -94965,7 +95169,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *670 examples: default: value: @@ -95019,8 +95223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -95032,9 +95236,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95052,14 +95256,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &669 + schema: &671 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -95127,8 +95331,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: false content: @@ -95154,7 +95358,7 @@ paths: description: Response content: application/json: - schema: *669 + schema: *671 examples: default: value: @@ -95181,8 +95385,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -95202,8 +95406,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -95259,7 +95463,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95282,8 +95486,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *342 - - *343 + - *344 + - *345 - name: ref in: path required: true @@ -95319,8 +95523,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *342 - - *343 + - *344 + - *345 - *17 - *19 responses: @@ -95330,11 +95534,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *259 + default: *261 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -95352,8 +95556,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *342 - - *343 + - *344 + - *345 - *19 - *17 responses: @@ -95361,7 +95565,7 @@ paths: description: Response content: application/json: - schema: &670 + schema: &672 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -95373,7 +95577,7 @@ paths: required: - names examples: - default: &671 + default: &673 value: names: - octocat @@ -95396,8 +95600,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -95428,9 +95632,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *672 examples: - default: *671 + default: *673 '404': *6 '422': *7 x-github: @@ -95451,9 +95655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *342 - - *343 - - &672 + - *344 + - *345 + - &674 name: per description: The time frame to display results for. in: query @@ -95482,7 +95686,7 @@ paths: example: 128 clones: type: array - items: &673 + items: &675 title: Traffic type: object properties: @@ -95569,8 +95773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -95660,8 +95864,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *342 - - *343 + - *344 + - *345 responses: '200': description: Response @@ -95721,9 +95925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *342 - - *343 - - *672 + - *344 + - *345 + - *674 responses: '200': description: Response @@ -95742,7 +95946,7 @@ paths: example: 3782 views: type: array - items: *673 + items: *675 required: - uniques - count @@ -95819,8 +96023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *342 - - *343 + - *344 + - *345 requestBody: required: true content: @@ -95856,7 +96060,7 @@ paths: description: Response content: application/json: - schema: *159 + schema: *161 examples: default: value: @@ -96093,8 +96297,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -96117,8 +96321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -96140,8 +96344,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -96167,8 +96371,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *342 - - *343 + - *344 + - *345 - name: ref in: path required: true @@ -96260,9 +96464,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 + default: *349 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -96303,7 +96507,7 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: default: value: @@ -96495,7 +96699,7 @@ paths: html_url: type: string format: uri - repository: *159 + repository: *161 score: type: number file_size: @@ -96513,7 +96717,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &674 + text_matches: &676 title: Search Result Text Matches type: array items: @@ -96627,7 +96831,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *120 + '503': *122 '422': *15 '403': *29 x-github: @@ -96675,7 +96879,7 @@ paths: enum: - author-date - committer-date - - &675 + - &677 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -96746,7 +96950,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *409 nullable: true comment_count: type: integer @@ -96766,7 +96970,7 @@ paths: url: type: string format: uri - verification: *531 + verification: *533 required: - author - committer @@ -96785,7 +96989,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *409 nullable: true parents: type: array @@ -96798,12 +97002,12 @@ paths: type: string sha: type: string - repository: *159 + repository: *161 score: type: number node_id: type: string - text_matches: *674 + text_matches: *676 required: - sha - node_id @@ -96995,7 +97199,7 @@ paths: - interactions - created - updated - - *675 + - *677 - *17 - *19 - name: advanced_search @@ -97109,11 +97313,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: type: string state_reason: @@ -97123,8 +97327,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *281 + required: *282 nullable: true comments: type: integer @@ -97138,7 +97342,7 @@ paths: type: string format: date-time nullable: true - text_matches: *674 + text_matches: *676 pull_request: type: object properties: @@ -97171,10 +97375,10 @@ paths: type: string score: type: number - author_association: *83 + author_association: *85 draft: type: boolean - repository: *80 + repository: *82 body_html: type: string body_text: @@ -97182,7 +97386,7 @@ paths: timeline_url: type: string format: uri - type: *242 + type: *244 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -97192,17 +97396,17 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 pinned_comment: title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - reactions: *84 + reactions: *86 required: - closed_at - comments @@ -97354,7 +97558,7 @@ paths: - quoted_text items: - "..." - '503': *120 + '503': *122 '422': *15 '304': *37 '403': *29 @@ -97408,7 +97612,7 @@ paths: enum: - created - updated - - *675 + - *677 - *17 - *19 responses: @@ -97452,7 +97656,7 @@ paths: nullable: true score: type: number - text_matches: *674 + text_matches: *676 required: - id - node_id @@ -97537,7 +97741,7 @@ paths: - forks - help-wanted-issues - updated - - *675 + - *677 - *17 - *19 responses: @@ -97765,8 +97969,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true permissions: type: object @@ -97785,7 +97989,7 @@ paths: - admin - pull - push - text_matches: *674 + text_matches: *676 temp_clone_token: type: string allow_merge_commit: @@ -97987,7 +98191,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *120 + '503': *122 '422': *15 '304': *37 x-github: @@ -98085,7 +98289,7 @@ paths: type: string format: uri nullable: true - text_matches: *674 + text_matches: *676 related: type: array nullable: true @@ -98276,7 +98480,7 @@ paths: - followers - repositories - joined - - *675 + - *677 - *17 - *19 responses: @@ -98380,7 +98584,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *674 + text_matches: *676 blog: type: string nullable: true @@ -98439,7 +98643,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *120 + '503': *122 '422': *15 x-github: githubCloudOnly: false @@ -98459,7 +98663,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &678 + - &680 name: team_id description: The unique identifier of the team. in: path @@ -98471,9 +98675,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '404': *6 x-github: githubCloudOnly: false @@ -98500,7 +98704,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *678 + - *680 requestBody: required: true content: @@ -98563,16 +98767,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '201': description: Response content: application/json: - schema: *338 + schema: *340 examples: - default: *339 + default: *341 '404': *6 '422': *15 '403': *29 @@ -98600,7 +98804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *678 + - *680 responses: '204': description: Response @@ -98629,7 +98833,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *678 + - *680 - *17 - *19 responses: @@ -98639,11 +98843,11 @@ paths: application/json: schema: type: array - items: *236 + items: *238 examples: - default: *237 + default: *239 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98667,7 +98871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *678 + - *680 - name: role description: Filters members returned by their role in the team. in: query @@ -98690,9 +98894,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -98718,8 +98922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '204': description: if user is a member @@ -98755,8 +98959,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '204': description: Response @@ -98795,8 +98999,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '204': description: Response @@ -98832,16 +99036,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '200': description: Response content: application/json: - schema: *341 + schema: *343 examples: - response-if-user-is-a-team-maintainer: *679 + response-if-user-is-a-team-maintainer: *681 '404': *6 x-github: githubCloudOnly: false @@ -98874,8 +99078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *678 - - *72 + - *680 + - *74 requestBody: required: false content: @@ -98900,9 +99104,9 @@ paths: description: Response content: application/json: - schema: *341 + schema: *343 examples: - response-if-users-membership-with-team-is-now-pending: *680 + response-if-users-membership-with-team-is-now-pending: *682 '403': description: Forbidden if team synchronization is set up '422': @@ -98936,8 +99140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *678 - - *72 + - *680 + - *74 responses: '204': description: Response @@ -98964,7 +99168,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *678 + - *680 - *17 - *19 responses: @@ -98974,11 +99178,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *273 + default: *275 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -99006,15 +99210,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *678 - - *342 - - *343 + - *680 + - *344 + - *345 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *681 + schema: *683 examples: alternative-response-with-extra-repository-information: value: @@ -99164,9 +99368,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *678 - - *342 - - *343 + - *680 + - *344 + - *345 requestBody: required: false content: @@ -99216,9 +99420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *678 - - *342 - - *343 + - *680 + - *344 + - *345 responses: '204': description: Response @@ -99243,7 +99447,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *678 + - *680 - *17 - *19 responses: @@ -99253,11 +99457,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - response-if-child-teams-exist: *682 + response-if-child-teams-exist: *684 headers: - Link: *68 + Link: *70 '404': *6 '403': *29 '422': *15 @@ -99288,7 +99492,7 @@ paths: application/json: schema: oneOf: - - &683 + - &685 title: Private User description: Private User type: object @@ -99491,7 +99695,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &709 + - &711 title: Public User description: Public User type: object @@ -99803,7 +100007,7 @@ paths: description: Response content: application/json: - schema: *683 + schema: *685 examples: default: value: @@ -99882,7 +100086,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '304': *37 '404': *6 '403': *29 @@ -99905,7 +100109,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *72 + - *74 responses: '204': description: If the user is blocked @@ -99933,7 +100137,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -99957,7 +100161,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -100006,9 +100210,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *249 examples: - default: *248 + default: *250 '304': *37 '500': *55 '401': *25 @@ -100147,21 +100351,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100201,7 +100405,7 @@ paths: type: integer secrets: type: array - items: &684 + items: &686 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -100241,9 +100445,9 @@ paths: - visibility - selected_repositories_url examples: - default: *466 + default: *468 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100311,13 +100515,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 responses: '200': description: Response content: application/json: - schema: *684 + schema: *686 examples: default: value: @@ -100347,7 +100551,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 requestBody: required: true content: @@ -100392,7 +100596,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -100420,7 +100624,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 responses: '204': description: Response @@ -100445,7 +100649,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *167 + - *169 responses: '200': description: Response @@ -100461,9 +100665,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *196 + default: *198 '401': *25 '403': *29 '404': *6 @@ -100488,7 +100692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *167 + - *169 requestBody: required: true content: @@ -100542,7 +100746,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *167 + - *169 - name: repository_id in: path required: true @@ -100575,7 +100779,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *167 + - *169 - name: repository_id in: path required: true @@ -100607,15 +100811,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '200': description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '304': *37 '500': *55 '401': *25 @@ -100641,7 +100845,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 requestBody: required: false content: @@ -100671,9 +100875,9 @@ paths: description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '401': *25 '403': *29 '404': *6 @@ -100695,7 +100899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '202': *39 '304': *37 @@ -100724,13 +100928,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '202': description: Response content: application/json: - schema: &685 + schema: &687 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100771,7 +100975,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &686 + default: &688 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100803,7 +101007,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *249 + - *251 - name: export_id in: path required: true @@ -100816,9 +101020,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: *686 + default: *688 '404': *6 x-github: githubCloudOnly: false @@ -100839,7 +101043,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *249 + - *251 responses: '200': description: Response @@ -100855,9 +101059,9 @@ paths: type: integer machines: type: array - items: *687 + items: *689 examples: - default: *688 + default: *690 '304': *37 '500': *55 '401': *25 @@ -100886,7 +101090,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *249 + - *251 requestBody: required: true content: @@ -100936,13 +101140,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *345 + repository: *347 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *464 - required: *465 + properties: *466 + required: *467 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -101716,15 +101920,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '200': description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '304': *37 '500': *55 '400': *14 @@ -101756,15 +101960,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *249 + - *251 responses: '200': description: Response content: application/json: - schema: *247 + schema: *249 examples: - default: *463 + default: *465 '500': *55 '401': *25 '403': *29 @@ -101794,9 +101998,9 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: &699 + default: &701 value: - id: 197 name: hello_docker @@ -101897,7 +102101,7 @@ paths: application/json: schema: type: array - items: &689 + items: &691 title: Email description: Email type: object @@ -101962,16 +102166,16 @@ paths: application/json: schema: type: array - items: *689 + items: *691 examples: - default: &701 + default: &703 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -102039,7 +102243,7 @@ paths: application/json: schema: type: array - items: *689 + items: *691 examples: default: value: @@ -102149,9 +102353,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -102182,9 +102386,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -102204,7 +102408,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *72 + - *74 responses: '204': description: if the person is followed by the authenticated user @@ -102234,7 +102438,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -102259,7 +102463,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -102295,7 +102499,7 @@ paths: application/json: schema: type: array - items: &690 + items: &692 title: GPG Key description: A unique encryption key type: object @@ -102426,7 +102630,7 @@ paths: - subkeys - revoked examples: - default: &718 + default: &720 value: - id: 3 name: Octocat's GPG Key @@ -102458,7 +102662,7 @@ paths: revoked: false raw_key: string headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -102511,9 +102715,9 @@ paths: description: Response content: application/json: - schema: *690 + schema: *692 examples: - default: &691 + default: &693 value: id: 3 name: Octocat's GPG Key @@ -102570,7 +102774,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &692 + - &694 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102582,9 +102786,9 @@ paths: description: Response content: application/json: - schema: *690 + schema: *692 examples: - default: *691 + default: *693 '404': *6 '304': *37 '403': *29 @@ -102607,7 +102811,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *692 + - *694 responses: '204': description: Response @@ -102750,7 +102954,7 @@ paths: suspended_at: suspended_by: headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -102798,11 +103002,11 @@ paths: type: array items: allOf: - - *80 + - *82 examples: - default: *151 + default: *153 headers: - Link: *68 + Link: *70 '404': *6 '403': *29 '304': *37 @@ -102826,7 +103030,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *148 + - *150 responses: '204': description: Response @@ -102852,7 +103056,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *148 + - *150 responses: '204': description: Response @@ -102886,12 +103090,12 @@ paths: application/json: schema: anyOf: - - *234 + - *236 - type: object properties: {} additionalProperties: false examples: - default: *235 + default: *237 '204': description: Response when there are no restrictions x-github: @@ -102915,7 +103119,7 @@ paths: required: true content: application/json: - schema: *542 + schema: *544 examples: default: value: @@ -102926,7 +103130,7 @@ paths: description: Response content: application/json: - schema: *234 + schema: *236 examples: default: value: @@ -103007,7 +103211,7 @@ paths: - closed - all default: open - - *245 + - *247 - name: sort description: What to sort results by. in: query @@ -103020,7 +103224,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -103030,11 +103234,11 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *246 + default: *248 headers: - Link: *68 + Link: *70 '404': *6 '304': *37 x-github: @@ -103065,7 +103269,7 @@ paths: application/json: schema: type: array - items: &693 + items: &695 title: Key description: Key type: object @@ -103116,7 +103320,7 @@ paths: verified: false read_only: false headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -103166,9 +103370,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *695 examples: - default: &694 + default: &696 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103201,15 +103405,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *577 + - *579 responses: '200': description: Response content: application/json: - schema: *693 + schema: *695 examples: - default: *694 + default: *696 '404': *6 '304': *37 '403': *29 @@ -103232,7 +103436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *577 + - *579 responses: '204': description: Response @@ -103265,7 +103469,7 @@ paths: application/json: schema: type: array - items: &695 + items: &697 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103322,7 +103526,7 @@ paths: - id - type - login - plan: *104 + plan: *106 required: - billing_cycle - next_billing_date @@ -103333,7 +103537,7 @@ paths: - account - plan examples: - default: &696 + default: &698 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103366,7 +103570,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '304': *37 '401': *25 '404': *6 @@ -103395,11 +103599,11 @@ paths: application/json: schema: type: array - items: *695 + items: *697 examples: - default: *696 + default: *698 headers: - Link: *68 + Link: *70 '304': *37 '401': *25 x-github: @@ -103437,7 +103641,7 @@ paths: application/json: schema: type: array - items: *251 + items: *253 examples: default: value: @@ -103520,7 +103724,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -103545,13 +103749,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *251 + schema: *253 examples: default: value: @@ -103613,7 +103817,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *76 + - *78 requestBody: required: true content: @@ -103638,7 +103842,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *253 examples: default: value: @@ -103710,7 +103914,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: default: value: @@ -103863,7 +104067,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -103963,7 +104167,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *255 examples: default: value: @@ -104143,7 +104347,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *254 + - *256 - name: exclude in: query required: false @@ -104156,7 +104360,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *255 examples: default: value: @@ -104350,7 +104554,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *254 + - *256 responses: '302': description: Response @@ -104376,7 +104580,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *254 + - *256 responses: '204': description: Response @@ -104405,8 +104609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *254 - - *697 + - *256 + - *699 responses: '204': description: Response @@ -104430,7 +104634,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *254 + - *256 - *17 - *19 responses: @@ -104442,7 +104646,7 @@ paths: type: array items: *67 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -104475,11 +104679,11 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -104519,7 +104723,7 @@ paths: - docker - nuget - container - - *698 + - *700 - *19 - *17 responses: @@ -104529,10 +104733,10 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: *699 - '400': *700 + default: *701 + '400': *702 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104552,16 +104756,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 + - *265 responses: '200': description: Response content: application/json: - schema: *260 + schema: *262 examples: - default: &719 + default: &721 value: id: 40201 name: octo-name @@ -104674,8 +104878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 + - *265 responses: '204': description: Response @@ -104705,8 +104909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 + - *265 - name: token description: package token schema: @@ -104738,8 +104942,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *262 - - *263 + - *264 + - *265 - *19 - *17 - name: state @@ -104759,7 +104963,7 @@ paths: application/json: schema: type: array - items: *264 + items: *266 examples: default: value: @@ -104808,15 +105012,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 - *265 + - *267 responses: '200': description: Response content: application/json: - schema: *264 + schema: *266 examples: default: value: @@ -104852,9 +105056,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 - *265 + - *267 responses: '204': description: Response @@ -104884,9 +105088,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *262 - - *263 + - *264 - *265 + - *267 responses: '204': description: Response @@ -104923,11 +105127,11 @@ paths: application/json: schema: type: array - items: *689 + items: *691 examples: - default: *701 + default: *703 headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -105036,9 +105240,9 @@ paths: application/json: schema: type: array - items: *80 + items: *82 examples: - default: &708 + default: &710 summary: Default response value: - id: 1296269 @@ -105159,7 +105363,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '403': *29 @@ -105342,9 +105546,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *347 examples: - default: *347 + default: *349 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105383,11 +105587,11 @@ paths: application/json: schema: type: array - items: *544 + items: *546 examples: - default: *702 + default: *704 headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -105408,7 +105612,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *238 + - *240 responses: '204': description: Response @@ -105432,7 +105636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *238 + - *240 responses: '204': description: Response @@ -105465,7 +105669,7 @@ paths: application/json: schema: type: array - items: &703 + items: &705 title: Social account description: Social media account type: object @@ -105480,12 +105684,12 @@ paths: - provider - url examples: - default: &704 + default: &706 value: - provider: twitter url: https://twitter.com/github headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -105542,9 +105746,9 @@ paths: application/json: schema: type: array - items: *703 + items: *705 examples: - default: *704 + default: *706 '422': *15 '304': *37 '404': *6 @@ -105631,7 +105835,7 @@ paths: application/json: schema: type: array - items: &705 + items: &707 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105651,7 +105855,7 @@ paths: - title - created_at examples: - default: &737 + default: &739 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105662,7 +105866,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -105715,9 +105919,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *707 examples: - default: &706 + default: &708 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105747,7 +105951,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &707 + - &709 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105759,9 +105963,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *707 examples: - default: *706 + default: *708 '404': *6 '304': *37 '403': *29 @@ -105784,7 +105988,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *707 + - *709 responses: '204': description: Response @@ -105813,7 +106017,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &738 + - &740 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -105836,13 +106040,13 @@ paths: application/json: schema: type: array - items: *80 + items: *82 examples: - default-response: *708 + default-response: *710 application/vnd.github.v3.star+json: schema: type: array - items: &739 + items: &741 title: Starred Repository description: Starred Repository type: object @@ -105850,7 +106054,7 @@ paths: starred_at: type: string format: date-time - repo: *80 + repo: *82 required: - starred_at - repo @@ -105978,7 +106182,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -105998,8 +106202,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response if this repository is starred by you @@ -106027,8 +106231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -106052,8 +106256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *342 - - *343 + - *344 + - *345 responses: '204': description: Response @@ -106086,11 +106290,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *273 + default: *275 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -106125,7 +106329,7 @@ paths: application/json: schema: type: array - items: *338 + items: *340 examples: default: value: @@ -106176,7 +106380,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -106203,7 +106407,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *106 + - *108 responses: '200': description: Response @@ -106211,10 +106415,10 @@ paths: application/json: schema: oneOf: - - *683 - - *709 + - *685 + - *711 examples: - default-response: &713 + default-response: &715 summary: Default response value: login: octocat @@ -106249,7 +106453,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &714 + response-with-git-hub-plan-information: &716 summary: Response with GitHub plan information value: login: octocat @@ -106306,14 +106510,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &711 + - &713 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *278 + - *280 requestBody: required: true description: Details of the draft item to create in the project. @@ -106347,9 +106551,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *286 examples: - draft_issue: *285 + draft_issue: *287 '304': *37 '403': *29 '401': *25 @@ -106372,7 +106576,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *710 + - *712 - *17 responses: '200': @@ -106383,7 +106587,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: Link: example: ; rel="next" @@ -106407,8 +106611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *711 - - *278 + - *713 + - *280 requestBody: required: true content: @@ -106479,17 +106683,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *712 + schema: *714 examples: table_view: summary: Response for creating a table view - value: *289 + value: *291 board_view: summary: Response for creating a board view with filter - value: *289 + value: *291 roadmap_view: summary: Response for creating a roadmap view - value: *289 + value: *291 '304': *37 '403': *29 '401': *25 @@ -106523,7 +106727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *72 + - *74 responses: '200': description: Response @@ -106531,11 +106735,11 @@ paths: application/json: schema: oneOf: - - *683 - - *709 + - *685 + - *711 examples: - default-response: *713 - response-with-git-hub-plan-information: *714 + default-response: *715 + response-with-git-hub-plan-information: *716 '404': *6 x-github: githubCloudOnly: false @@ -106561,7 +106765,7 @@ paths: - *17 - *47 - *48 - - *72 + - *74 requestBody: required: true content: @@ -106585,8 +106789,8 @@ paths: required: - subject_digests examples: - default: *715 - withPredicateType: *716 + default: *717 + withPredicateType: *718 responses: '200': description: Response @@ -106625,7 +106829,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *717 + default: *719 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106643,7 +106847,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *72 + - *74 requestBody: required: true content: @@ -106708,7 +106912,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *72 + - *74 - name: subject_digest description: Subject Digest in: path @@ -106739,7 +106943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *72 + - *74 - name: attestation_id description: Attestation ID in: path @@ -106777,7 +106981,7 @@ paths: - *17 - *47 - *48 - - *72 + - *74 - name: subject_digest description: Subject Digest in: path @@ -106814,12 +107018,12 @@ paths: initiator: type: string examples: - default: *403 + default: *405 '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -106845,7 +107049,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *72 + - *74 responses: '200': description: Response @@ -106853,9 +107057,9 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: *699 + default: *701 '403': *29 '401': *25 x-github: @@ -106878,7 +107082,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -106888,7 +107092,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -106950,8 +107154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *72 - - *76 + - *74 + - *78 - *17 - *19 responses: @@ -106961,7 +107165,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -107038,7 +107242,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107048,7 +107252,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -107106,7 +107310,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107118,9 +107322,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107137,7 +107341,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107149,9 +107353,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107168,7 +107372,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *72 + - *74 - name: target_user in: path required: true @@ -107195,8 +107399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *72 - - *93 + - *74 + - *95 - *17 - *19 responses: @@ -107206,11 +107410,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -107229,7 +107433,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107239,11 +107443,11 @@ paths: application/json: schema: type: array - items: *690 + items: *692 examples: - default: *718 + default: *720 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107265,7 +107469,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *72 + - *74 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -107337,7 +107541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *72 + - *74 responses: '200': description: Response @@ -107345,7 +107549,7 @@ paths: application/json: schema: *22 examples: - default: *541 + default: *543 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107363,7 +107567,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107398,7 +107602,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107418,7 +107622,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -107428,11 +107632,11 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107469,8 +107673,8 @@ paths: - docker - nuget - container - - *698 - - *72 + - *700 + - *74 - *19 - *17 responses: @@ -107480,12 +107684,12 @@ paths: application/json: schema: type: array - items: *260 + items: *262 examples: - default: *699 + default: *701 '403': *29 '401': *25 - '400': *700 + '400': *702 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107505,17 +107709,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 + - *265 + - *74 responses: '200': description: Response content: application/json: - schema: *260 + schema: *262 examples: - default: *719 + default: *721 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107536,9 +107740,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 + - *265 + - *74 responses: '204': description: Response @@ -107570,9 +107774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 + - *265 + - *74 - name: token description: package token schema: @@ -107604,9 +107808,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *262 - - *263 - - *72 + - *264 + - *265 + - *74 responses: '200': description: Response @@ -107614,7 +107818,7 @@ paths: application/json: schema: type: array - items: *264 + items: *266 examples: default: value: @@ -107672,16 +107876,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *262 - - *263 + - *264 - *265 - - *72 + - *267 + - *74 responses: '200': description: Response content: application/json: - schema: *264 + schema: *266 examples: default: value: @@ -107716,10 +107920,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 - *265 + - *74 + - *267 responses: '204': description: Response @@ -107751,10 +107955,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *262 - - *263 - - *72 + - *264 - *265 + - *74 + - *267 responses: '204': description: Response @@ -107778,7 +107982,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *72 + - *74 - name: q description: Limit results to projects of the specified type. in: query @@ -107795,11 +107999,11 @@ paths: application/json: schema: type: array - items: *276 + items: *278 examples: - default: *277 + default: *279 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -107819,18 +108023,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *278 - - *72 + - *280 + - *74 responses: '200': description: Response content: application/json: - schema: *276 + schema: *278 examples: - default: *277 + default: *279 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -107850,8 +108054,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *278 - - *72 + - *280 + - *74 - *17 - *47 - *48 @@ -107862,11 +108066,11 @@ paths: application/json: schema: type: array - items: *282 + items: *284 examples: - default: *720 + default: *722 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -107885,8 +108089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - - *72 - - *278 + - *74 + - *280 requestBody: required: true content: @@ -107924,7 +108128,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *721 + items: *723 required: - name - data_type @@ -107940,7 +108144,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *722 + iteration_configuration: *724 required: - name - data_type @@ -107962,20 +108166,20 @@ paths: value: name: Due date data_type: date - single_select_field: *723 - iteration_field: *724 + single_select_field: *725 + iteration_field: *726 responses: '201': description: Response content: application/json: - schema: *282 + schema: *284 examples: - text_field: *725 - number_field: *726 - date_field: *727 - single_select_field: *728 - iteration_field: *729 + text_field: *727 + number_field: *728 + date_field: *729 + single_select_field: *730 + iteration_field: *731 '304': *37 '403': *29 '401': *25 @@ -107996,19 +108200,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *278 - - *730 - - *72 + - *280 + - *732 + - *74 responses: '200': description: Response content: application/json: - schema: *282 + schema: *284 examples: - default: *731 + default: *733 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108029,8 +108233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *278 - - *72 + - *280 + - *74 - *47 - *48 - *17 @@ -108062,11 +108266,11 @@ paths: application/json: schema: type: array - items: *286 + items: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108085,8 +108289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *72 - - *278 + - *74 + - *280 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -108156,22 +108360,22 @@ paths: description: Response content: application/json: - schema: *284 + schema: *286 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *285 + value: *287 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *285 + value: *287 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *285 + value: *287 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *285 + value: *287 '304': *37 '403': *29 '401': *25 @@ -108191,9 +108395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *278 - - *72 - - *288 + - *280 + - *74 + - *290 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -108213,11 +108417,11 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108236,9 +108440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *278 - - *72 - - *288 + - *280 + - *74 + - *290 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -108308,13 +108512,13 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - text_field: *287 - number_field: *287 - date_field: *287 - single_select_field: *287 - iteration_field: *287 + text_field: *289 + number_field: *289 + date_field: *289 + single_select_field: *289 + iteration_field: *289 '401': *25 '403': *29 '404': *6 @@ -108334,9 +108538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *278 - - *72 - - *288 + - *280 + - *74 + - *290 responses: '204': description: Response @@ -108358,9 +108562,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *278 - - *72 - - *732 + - *280 + - *74 + - *734 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -108386,11 +108590,11 @@ paths: application/json: schema: type: array - items: *286 + items: *288 examples: - default: *287 + default: *289 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -108416,7 +108620,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108426,7 +108630,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -108491,7 +108695,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108501,7 +108705,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -108564,7 +108768,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *72 + - *74 - name: type description: Limit results to repositories of the specified type. in: query @@ -108607,11 +108811,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *273 + default: *275 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108631,12 +108835,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - - *72 - - *122 + - *74 - *124 - - *123 - - *733 + - *126 - *125 + - *735 + - *127 responses: '200': description: Response when getting a billing premium request usage report @@ -108744,7 +108948,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108764,10 +108968,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - - *72 - - *122 - - *734 - - *123 + - *74 + - *124 + - *736 + - *125 responses: '200': description: Response when getting a billing usage report @@ -108838,7 +109042,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108861,13 +109065,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - - *72 - - *122 + - *74 - *124 - - *123 - - *735 + - *126 - *125 - - *736 + - *737 + - *127 + - *738 responses: '200': description: Response when getting a billing usage summary @@ -108973,7 +109177,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108991,7 +109195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -109001,11 +109205,11 @@ paths: application/json: schema: type: array - items: *703 + items: *705 examples: - default: *704 + default: *706 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109023,7 +109227,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -109033,11 +109237,11 @@ paths: application/json: schema: type: array - items: *705 + items: *707 examples: - default: *737 + default: *739 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109059,8 +109263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *72 - - *738 + - *74 + - *740 - *62 - *17 - *19 @@ -109072,13 +109276,13 @@ paths: schema: anyOf: - type: array - items: *739 + items: *741 - type: array - items: *80 + items: *82 examples: - default-response: *708 + default-response: *710 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109095,7 +109299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -109105,11 +109309,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *273 + default: *275 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109235,7 +109439,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &740 + enterprise: &742 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -109293,7 +109497,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &741 + installation: &743 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -109312,7 +109516,7 @@ x-webhooks: required: - id - node_id - organization: &742 + organization: &744 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -109372,13 +109576,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &743 + repository: &745 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &775 + properties: &777 id: description: Unique identifier of the repository example: 42 @@ -109398,8 +109602,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true organization: title: Simple User @@ -110062,7 +110266,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &776 + required: &778 - archive_url - assignees_url - blobs_url @@ -110213,10 +110417,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -110292,11 +110496,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - rule: &744 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + rule: &746 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -110519,11 +110723,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - rule: *744 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + rule: *746 sender: *4 required: - action @@ -110706,11 +110910,11 @@ x-webhooks: - everyone required: - from - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - rule: *744 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + rule: *746 sender: *4 required: - action @@ -110794,7 +110998,7 @@ x-webhooks: type: string enum: - completed - check_run: &746 + check_run: &748 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110847,8 +111051,8 @@ x-webhooks: type: string pull_requests: type: array - items: *91 - repository: *159 + items: *93 + repository: *161 status: example: completed type: string @@ -110885,7 +111089,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *745 + deployment: *747 details_url: example: https://example.com type: string @@ -110935,7 +111139,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *91 + items: *93 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -110970,10 +111174,10 @@ x-webhooks: - output - app - pull_requests - installation: *741 - enterprise: *740 - organization: *742 - repository: *743 + installation: *743 + enterprise: *742 + organization: *744 + repository: *745 sender: *4 required: - check_run @@ -111364,11 +111568,11 @@ x-webhooks: type: string enum: - created - check_run: *746 - installation: *741 - enterprise: *740 - organization: *742 - repository: *743 + check_run: *748 + installation: *743 + enterprise: *742 + organization: *744 + repository: *745 sender: *4 required: - check_run @@ -111762,11 +111966,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *746 - installation: *741 - enterprise: *740 - organization: *742 - repository: *743 + check_run: *748 + installation: *743 + enterprise: *742 + organization: *744 + repository: *745 requested_action: description: The action requested by the user. type: object @@ -112169,11 +112373,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *746 - installation: *741 - enterprise: *740 - organization: *742 - repository: *743 + check_run: *748 + installation: *743 + enterprise: *742 + organization: *744 + repository: *745 sender: *4 required: - check_run @@ -113143,10 +113347,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -113835,10 +114039,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -114521,10 +114725,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -114690,7 +114894,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -114835,20 +115039,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &747 + commit_oid: &749 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *740 - installation: *741 - organization: *742 - ref: &748 + enterprise: *742 + installation: *743 + organization: *744 + ref: &750 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *743 + repository: *745 sender: *4 required: - action @@ -115013,7 +115217,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -115243,12 +115447,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *747 - enterprise: *740 - installation: *741 - organization: *742 - ref: *748 - repository: *743 + commit_oid: *749 + enterprise: *742 + installation: *743 + organization: *744 + ref: *750 + repository: *745 sender: *4 required: - action @@ -115343,7 +115547,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115514,12 +115718,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *747 - enterprise: *740 - installation: *741 - organization: *742 - ref: *748 - repository: *743 + commit_oid: *749 + enterprise: *742 + installation: *743 + organization: *744 + ref: *750 + repository: *745 sender: *4 required: - action @@ -115685,7 +115889,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -115851,12 +116055,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *747 - enterprise: *740 - installation: *741 - organization: *742 - ref: *748 - repository: *743 + commit_oid: *749 + enterprise: *742 + installation: *743 + organization: *744 + ref: *750 + repository: *745 sender: *4 required: - action @@ -115955,7 +116159,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116130,16 +116334,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *743 + repository: *745 sender: *4 required: - action @@ -116236,7 +116440,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116376,12 +116580,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *747 - enterprise: *740 - installation: *741 - organization: *742 - ref: *748 - repository: *743 + commit_oid: *749 + enterprise: *742 + installation: *743 + organization: *744 + ref: *750 + repository: *745 sender: *4 required: - action @@ -116547,7 +116751,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *437 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116692,10 +116896,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -116950,10 +117154,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -117033,18 +117237,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *742 - pusher_type: &749 + organization: *744 + pusher_type: &751 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &750 + ref: &752 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -117054,7 +117258,7 @@ x-webhooks: enum: - tag - branch - repository: *743 + repository: *745 sender: *4 required: - ref @@ -117136,10 +117340,10 @@ x-webhooks: type: string enum: - created - definition: *290 - enterprise: *740 - installation: *741 - organization: *742 + definition: *292 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -117224,9 +117428,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -117303,10 +117507,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *290 - enterprise: *740 - installation: *741 - organization: *742 + definition: *292 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -117383,10 +117587,10 @@ x-webhooks: type: string enum: - updated - definition: *290 - enterprise: *740 - installation: *741 - organization: *742 + definition: *292 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -117463,19 +117667,19 @@ x-webhooks: type: string enum: - updated - enterprise: *740 - installation: *741 - repository: *743 - organization: *742 + enterprise: *742 + installation: *743 + repository: *745 + organization: *744 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *294 + items: *296 old_property_values: type: array description: The old custom property values for the repository. - items: *294 + items: *296 required: - action - repository @@ -117551,18 +117755,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 - pusher_type: *749 - ref: *750 + enterprise: *742 + installation: *743 + organization: *744 + pusher_type: *751 + ref: *752 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *743 + repository: *745 sender: *4 required: - ref @@ -117642,11 +117846,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -117726,11 +117930,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -117811,11 +118015,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -117896,11 +118100,11 @@ x-webhooks: type: string enum: - created - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -117979,11 +118183,11 @@ x-webhooks: type: string enum: - dismissed - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118062,11 +118266,11 @@ x-webhooks: type: string enum: - fixed - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118146,11 +118350,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118229,11 +118433,11 @@ x-webhooks: type: string enum: - reopened - alert: *499 - installation: *741 - organization: *742 - enterprise: *740 - repository: *743 + alert: *501 + installation: *743 + organization: *744 + enterprise: *742 + repository: *745 sender: *4 required: - action @@ -118310,9 +118514,9 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - key: &751 + enterprise: *742 + installation: *743 + key: &753 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -118348,8 +118552,8 @@ x-webhooks: - verified - created_at - read_only - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -118426,11 +118630,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - key: *751 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + key: *753 + organization: *744 + repository: *745 sender: *4 required: - action @@ -118986,12 +119190,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: &757 + workflow: &759 title: Workflow type: object nullable: true @@ -119732,15 +119936,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *752 - required: *753 + properties: *754 + required: *755 nullable: true pull_requests: type: array - items: *596 - repository: *743 - organization: *742 - installation: *741 + items: *598 + repository: *745 + organization: *744 + installation: *743 sender: *4 responses: '200': @@ -119811,7 +120015,7 @@ x-webhooks: type: string enum: - approved - approver: &754 + approver: &756 type: object properties: avatar_url: @@ -119854,11 +120058,11 @@ x-webhooks: type: string comment: type: string - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - reviewers: &755 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + reviewers: &757 type: array items: type: object @@ -119937,7 +120141,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &756 + workflow_job_run: &758 type: object properties: conclusion: @@ -120668,18 +120872,18 @@ x-webhooks: type: string enum: - rejected - approver: *754 + approver: *756 comment: type: string - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - reviewers: *755 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + reviewers: *757 sender: *4 since: type: string - workflow_job_run: *756 + workflow_job_run: *758 workflow_job_runs: type: array items: @@ -121383,13 +121587,13 @@ x-webhooks: type: string enum: - requested - enterprise: *740 + enterprise: *742 environment: type: string - installation: *741 - organization: *742 - repository: *743 - requestor: &762 + installation: *743 + organization: *744 + repository: *745 + requestor: &764 title: User type: object nullable: true @@ -123278,12 +123482,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: *757 + workflow: *759 workflow_run: title: Deployment Workflow Run type: object @@ -123963,7 +124167,7 @@ x-webhooks: type: string enum: - answered - answer: &760 + answer: &762 type: object properties: author_association: @@ -124120,11 +124324,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124251,11 +124455,11 @@ x-webhooks: - from required: - category - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124338,11 +124542,11 @@ x-webhooks: type: string enum: - closed - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124424,7 +124628,7 @@ x-webhooks: type: string enum: - created - comment: &759 + comment: &761 type: object properties: author_association: @@ -124581,11 +124785,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124668,12 +124872,12 @@ x-webhooks: type: string enum: - deleted - comment: *759 - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + comment: *761 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124768,12 +124972,12 @@ x-webhooks: - from required: - body - comment: *759 - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + comment: *761 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124857,11 +125061,11 @@ x-webhooks: type: string enum: - created - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -124943,11 +125147,11 @@ x-webhooks: type: string enum: - deleted - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125047,11 +125251,11 @@ x-webhooks: type: string required: - from - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125133,10 +125337,10 @@ x-webhooks: type: string enum: - labeled - discussion: *758 - enterprise: *740 - installation: *741 - label: &761 + discussion: *760 + enterprise: *742 + installation: *743 + label: &763 title: Label type: object properties: @@ -125168,8 +125372,8 @@ x-webhooks: - color - default - description - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125252,11 +125456,11 @@ x-webhooks: type: string enum: - locked - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125338,11 +125542,11 @@ x-webhooks: type: string enum: - pinned - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125424,11 +125628,11 @@ x-webhooks: type: string enum: - reopened - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125513,16 +125717,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *758 - new_repository: *743 + new_discussion: *760 + new_repository: *745 required: - new_discussion - new_repository - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125605,10 +125809,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *758 - old_answer: *760 - organization: *742 - repository: *743 + discussion: *760 + old_answer: *762 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125690,12 +125894,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *758 - enterprise: *740 - installation: *741 - label: *761 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125778,11 +125982,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125864,11 +126068,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *758 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + discussion: *760 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -125941,7 +126145,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *740 + enterprise: *742 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126601,9 +126805,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *741 - organization: *742 - repository: *743 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - forkee @@ -126749,9 +126953,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pages: description: The pages that were updated. type: array @@ -126788,7 +126992,7 @@ x-webhooks: - action - sha - html_url - repository: *743 + repository: *745 sender: *4 required: - pages @@ -126864,10 +127068,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: &763 + organization: *744 + repositories: &765 description: An array of repository objects that the installation can access. type: array @@ -126893,8 +127097,8 @@ x-webhooks: - name - full_name - private - repository: *743 - requester: *762 + repository: *745 + requester: *764 sender: *4 required: - action @@ -126969,11 +127173,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: *763 - repository: *743 + organization: *744 + repositories: *765 + repository: *745 requester: nullable: true sender: *4 @@ -127049,11 +127253,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: *763 - repository: *743 + organization: *744 + repositories: *765 + repository: *745 requester: nullable: true sender: *4 @@ -127129,10 +127333,10 @@ x-webhooks: type: string enum: - added - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories_added: &764 + organization: *744 + repositories_added: &766 description: An array of repository objects, which were added to the installation. type: array @@ -127178,15 +127382,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *743 - repository_selection: &765 + repository: *745 + repository_selection: &767 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *762 + requester: *764 sender: *4 required: - action @@ -127265,10 +127469,10 @@ x-webhooks: type: string enum: - removed - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories_added: *764 + organization: *744 + repositories_added: *766 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127295,9 +127499,9 @@ x-webhooks: - name - full_name - private - repository: *743 - repository_selection: *765 - requester: *762 + repository: *745 + repository_selection: *767 + requester: *764 sender: *4 required: - action @@ -127376,11 +127580,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: *763 - repository: *743 + organization: *744 + repositories: *765 + repository: *745 requester: nullable: true sender: *4 @@ -127558,10 +127762,10 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 target_type: type: string @@ -127640,11 +127844,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *740 + enterprise: *742 installation: *22 - organization: *742 - repositories: *763 - repository: *743 + organization: *744 + repositories: *765 + repository: *745 requester: nullable: true sender: *4 @@ -127768,8 +127972,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 reactions: title: Reactions type: object @@ -127818,8 +128022,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *573 - required: *574 + properties: *575 + required: *576 nullable: true user: title: User @@ -127904,8 +128108,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128694,8 +128898,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128711,7 +128915,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -129044,8 +129248,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -129125,7 +129329,7 @@ x-webhooks: type: string enum: - deleted - comment: &766 + comment: &768 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129282,8 +129486,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *573 - required: *574 + properties: *575 + required: *576 nullable: true required: - url @@ -129298,8 +129502,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -130084,8 +130288,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130101,7 +130305,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -130436,8 +130640,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -130517,7 +130721,7 @@ x-webhooks: type: string enum: - edited - changes: &795 + changes: &797 description: The changes to the comment. type: object properties: @@ -130529,9 +130733,9 @@ x-webhooks: type: string required: - from - comment: *766 - enterprise: *740 - installation: *741 + comment: *768 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131319,8 +131523,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131336,7 +131540,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -131669,8 +131873,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -131751,9 +131955,9 @@ x-webhooks: type: string enum: - pinned - comment: *766 - enterprise: *740 - installation: *741 + comment: *768 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -132543,8 +132747,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132560,7 +132764,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -132895,8 +133099,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -132976,9 +133180,9 @@ x-webhooks: type: string enum: - unpinned - comment: *766 - enterprise: *740 - installation: *741 + comment: *768 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133768,8 +133972,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133785,7 +133989,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -134120,8 +134324,8 @@ x-webhooks: - state - locked - assignee - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134204,15 +134408,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 + blocked_issue: *88 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - blocking_issue_repo: *80 - installation: *741 - organization: *742 - repository: *743 + blocking_issue: *88 + blocking_issue_repo: *82 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134295,15 +134499,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 + blocked_issue: *88 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - blocking_issue_repo: *80 - installation: *741 - organization: *742 - repository: *743 + blocking_issue: *88 + blocking_issue_repo: *82 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134385,15 +134589,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 - blocked_issue_repo: *80 + blocked_issue: *88 + blocked_issue_repo: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - installation: *741 - organization: *742 - repository: *743 + blocking_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134476,15 +134680,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 - blocked_issue_repo: *80 + blocked_issue: *88 + blocked_issue_repo: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - installation: *741 - organization: *742 - repository: *743 + blocking_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -134564,9 +134768,9 @@ x-webhooks: type: string enum: - assigned - assignee: *762 - enterprise: *740 - installation: *741 + assignee: *764 + enterprise: *742 + installation: *743 issue: &769 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135356,14 +135560,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135379,7 +135583,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -135480,8 +135684,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -135561,8 +135765,8 @@ x-webhooks: type: string enum: - closed - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -136356,14 +136560,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136379,7 +136583,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -136615,8 +136819,8 @@ x-webhooks: required: - state - closed_at - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -136695,8 +136899,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137481,14 +137685,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137504,7 +137708,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -137604,8 +137808,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -137684,8 +137888,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138492,14 +138696,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138515,7 +138719,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -138594,7 +138798,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &767 + milestone: &770 title: Milestone description: A collection of related issues and pull requests. type: object @@ -138732,8 +138936,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -138832,8 +139036,8 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139622,14 +139826,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139642,7 +139846,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *244 title: description: Title of the issue type: string @@ -139746,9 +139950,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *761 - organization: *742 - repository: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -139768,6 +139972,339 @@ x-webhooks: - repository - organization - app + issues-field-added: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue field value was set or updated on an issue. + operationId: issues/field-added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issues field_added event + type: object + properties: + action: + type: string + enum: + - field_added + enterprise: *742 + installation: *743 + issue: *769 + issue_field: + type: object + description: The issue field whose value was set or updated on the + issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was set or updated for the issue field. + When updating an existing value, the previous value is available + in `changes`. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present + for single_select field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + changes: + type: object + description: The previous field value, present when an existing + value was updated. + properties: + issue_field_value: + type: object + description: The previous issue field value data. + properties: + from: + type: object + description: The previous value of the issue field before + the update. + properties: + id: + type: integer + description: The unique identifier of the issue field + value. + value: + description: The previous value. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the previously selected + option. Present for single_select field types. + option: + type: object + description: The previously selected option details. + Present for single_select field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + required: + - from + organization: *744 + repository: *745 + sender: *4 + required: + - action + - issue + - issue_field + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-field-removed: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue field value was cleared from an issue. + operationId: issues/field-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issues field_removed event + type: object + properties: + action: + type: string + enum: + - field_removed + enterprise: *742 + installation: *743 + issue: *769 + issue_field: + type: object + description: The issue field whose value was cleared from the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was cleared from the issue field. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present + for single_select field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + organization: *744 + repository: *745 + sender: *4 + required: + - action + - issue + - issue_field + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app issues-labeled: post: summary: |- @@ -139828,8 +140365,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140617,14 +141154,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140637,7 +141174,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *244 title: description: Title of the issue type: string @@ -140741,9 +141278,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *761 - organization: *742 - repository: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -140823,8 +141360,8 @@ x-webhooks: type: string enum: - locked - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141636,14 +142173,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141656,7 +142193,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *244 title: description: Title of the issue type: string @@ -141737,8 +142274,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -141817,8 +142354,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142624,14 +143161,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142647,7 +143184,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -142725,9 +143262,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *767 - organization: *742 - repository: *743 + milestone: *770 + organization: *744 + repository: *745 sender: *4 required: - action @@ -143590,11 +144127,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143622,8 +144159,8 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true user: title: User @@ -143695,7 +144232,7 @@ x-webhooks: required: - login - id - type: *242 + type: *244 required: - id - number @@ -144175,8 +144712,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144960,11 +145497,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144980,7 +145517,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -144993,8 +145530,8 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true user: title: User @@ -145088,8 +145625,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -145169,9 +145706,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *740 - installation: *741 - issue: &768 + enterprise: *742 + installation: *743 + issue: &771 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -145954,14 +146491,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145977,7 +146514,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -146077,8 +146614,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -146157,8 +146694,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146968,14 +147505,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147069,9 +147606,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *242 - organization: *742 - repository: *743 + type: *244 + organization: *744 + repository: *745 sender: *4 required: - action @@ -147937,14 +148474,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147960,7 +148497,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -148539,11 +149076,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *740 - installation: *741 - issue: *768 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + issue: *771 + organization: *744 + repository: *745 sender: *4 required: - action @@ -148623,12 +149160,12 @@ x-webhooks: type: string enum: - typed - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: *769 - type: *242 - organization: *742 - repository: *743 + type: *244 + organization: *744 + repository: *745 sender: *4 required: - action @@ -148709,7 +149246,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &798 + assignee: &800 title: User type: object nullable: true @@ -148779,11 +149316,11 @@ x-webhooks: required: - login - id - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: *769 - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -148862,12 +149399,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: *769 - label: *761 - organization: *742 - repository: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -148947,8 +149484,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149758,14 +150295,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *676 - issue_dependencies_summary: *677 + sub_issues_summary: *678 + issue_dependencies_summary: *679 issue_field_values: type: array - items: *557 + items: *559 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149781,7 +150318,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *244 updated_at: type: string format: date-time @@ -149859,8 +150396,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -149940,11 +150477,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *740 - installation: *741 - issue: *768 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + issue: *771 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150023,12 +150560,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 issue: *769 - type: *242 - organization: *742 - repository: *743 + type: *244 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150108,11 +150645,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - label: *761 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150190,11 +150727,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - label: *761 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150304,11 +150841,11 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - label: *761 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + label: *763 + organization: *744 + repository: *745 sender: *4 required: - action @@ -150390,9 +150927,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *740 - installation: *741 - marketplace_purchase: &770 + enterprise: *742 + installation: *743 + marketplace_purchase: &772 title: Marketplace Purchase type: object required: @@ -150475,8 +151012,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *742 - previous_marketplace_purchase: &771 + organization: *744 + previous_marketplace_purchase: &773 title: Marketplace Purchase type: object properties: @@ -150556,7 +151093,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *743 + repository: *745 sender: *4 required: - action @@ -150636,10 +151173,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *740 - installation: *741 - marketplace_purchase: *770 - organization: *742 + enterprise: *742 + installation: *743 + marketplace_purchase: *772 + organization: *744 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -150722,7 +151259,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *743 + repository: *745 sender: *4 required: - action @@ -150804,10 +151341,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *740 - installation: *741 - marketplace_purchase: *770 - organization: *742 + enterprise: *742 + installation: *743 + marketplace_purchase: *772 + organization: *744 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -150889,7 +151426,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *743 + repository: *745 sender: *4 required: - action @@ -150970,8 +151507,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 marketplace_purchase: title: Marketplace Purchase type: object @@ -151053,9 +151590,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *742 - previous_marketplace_purchase: *771 - repository: *743 + organization: *744 + previous_marketplace_purchase: *773 + repository: *745 sender: *4 required: - action @@ -151135,12 +151672,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *740 - installation: *741 - marketplace_purchase: *770 - organization: *742 - previous_marketplace_purchase: *771 - repository: *743 + enterprise: *742 + installation: *743 + marketplace_purchase: *772 + organization: *744 + previous_marketplace_purchase: *773 + repository: *745 sender: *4 required: - action @@ -151242,11 +151779,11 @@ x-webhooks: type: string required: - to - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 sender: *4 required: - action @@ -151346,11 +151883,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 sender: *4 required: - action @@ -151429,11 +151966,11 @@ x-webhooks: type: string enum: - removed - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 sender: *4 required: - action @@ -151511,11 +152048,11 @@ x-webhooks: type: string enum: - added - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 scope: description: The scope of the membership. Currently, can only be `team`. @@ -151591,7 +152128,7 @@ x-webhooks: required: - login - id - team: &772 + team: &774 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -151814,11 +152351,11 @@ x-webhooks: type: string enum: - removed - enterprise: *740 - installation: *741 - member: *762 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + member: *764 + organization: *744 + repository: *745 scope: description: The scope of the membership. Currently, can only be `team`. @@ -151895,7 +152432,7 @@ x-webhooks: required: - login - id - team: *772 + team: *774 required: - action - scope @@ -151977,8 +152514,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *741 - merge_group: &774 + installation: *743 + merge_group: &776 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -151997,15 +152534,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *773 + head_commit: *775 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152091,10 +152628,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *741 - merge_group: *774 - organization: *742 - repository: *743 + installation: *743 + merge_group: *776 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152167,7 +152704,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 + enterprise: *742 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -152276,16 +152813,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *741 - organization: *742 + installation: *743 + organization: *744 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *775 - required: *776 + properties: *777 + required: *778 nullable: true sender: *4 required: @@ -152366,11 +152903,11 @@ x-webhooks: type: string enum: - closed - enterprise: *740 - installation: *741 - milestone: *767 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + milestone: *770 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152449,9 +152986,9 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - milestone: &777 + enterprise: *742 + installation: *743 + milestone: &779 title: Milestone description: A collection of related issues and pull requests. type: object @@ -152588,8 +153125,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152668,11 +153205,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - milestone: *767 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + milestone: *770 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152782,11 +153319,11 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - milestone: *767 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + milestone: *770 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152866,11 +153403,11 @@ x-webhooks: type: string enum: - opened - enterprise: *740 - installation: *741 - milestone: *777 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + milestone: *779 + organization: *744 + repository: *745 sender: *4 required: - action @@ -152949,11 +153486,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *762 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + blocked_user: *764 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153032,11 +153569,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *762 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + blocked_user: *764 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153115,9 +153652,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - membership: &778 + enterprise: *742 + installation: *743 + membership: &780 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -153224,8 +153761,8 @@ x-webhooks: - role - organization_url - user - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153303,11 +153840,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *740 - installation: *741 - membership: *778 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + membership: *780 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153386,8 +153923,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -153503,10 +154040,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 - user: *762 + user: *764 required: - action - invitation @@ -153584,11 +154121,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *740 - installation: *741 - membership: *778 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + membership: *780 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153675,11 +154212,11 @@ x-webhooks: properties: from: type: string - enterprise: *740 - installation: *741 - membership: *778 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + membership: *780 + organization: *744 + repository: *745 sender: *4 required: - action @@ -153756,9 +154293,9 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 package: description: Information about the package. type: object @@ -154257,7 +154794,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &779 + items: &781 title: Ruby Gems metadata type: object properties: @@ -154352,7 +154889,7 @@ x-webhooks: - owner - package_version - registry - repository: *743 + repository: *745 sender: *4 required: - action @@ -154428,9 +154965,9 @@ x-webhooks: type: string enum: - updated - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 package: description: Information about the package. type: object @@ -154783,7 +155320,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 source_url: type: string format: uri @@ -154853,7 +155390,7 @@ x-webhooks: - owner - package_version - registry - repository: *743 + repository: *745 sender: *4 required: - action @@ -155029,12 +155566,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *740 + enterprise: *742 id: type: integer - installation: *741 - organization: *742 - repository: *743 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - id @@ -155111,7 +155648,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &780 + personal_access_token_request: &782 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -155257,10 +155794,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *740 - organization: *742 + enterprise: *742 + organization: *744 sender: *4 - installation: *741 + installation: *743 required: - action - personal_access_token_request @@ -155337,11 +155874,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *780 - enterprise: *740 - organization: *742 + personal_access_token_request: *782 + enterprise: *742 + organization: *744 sender: *4 - installation: *741 + installation: *743 required: - action - personal_access_token_request @@ -155417,11 +155954,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *780 - enterprise: *740 - organization: *742 + personal_access_token_request: *782 + enterprise: *742 + organization: *744 sender: *4 - installation: *741 + installation: *743 required: - action - personal_access_token_request @@ -155496,11 +156033,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *780 - organization: *742 - enterprise: *740 + personal_access_token_request: *782 + organization: *744 + enterprise: *742 sender: *4 - installation: *741 + installation: *743 required: - action - personal_access_token_request @@ -155605,7 +156142,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *781 + last_response: *783 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -155637,8 +156174,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 zen: description: Random string of GitHub zen. @@ -155883,10 +156420,10 @@ x-webhooks: - from required: - note - enterprise: *740 - installation: *741 - organization: *742 - project_card: &782 + enterprise: *742 + installation: *743 + organization: *744 + project_card: &784 title: Project Card type: object properties: @@ -156005,7 +156542,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *743 + repository: *745 sender: *4 required: - action @@ -156086,11 +156623,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - project_card: *782 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project_card: *784 + repository: *745 sender: *4 required: - action @@ -156170,9 +156707,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 project_card: title: Project Card type: object @@ -156300,8 +156837,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *775 - required: *776 + properties: *777 + required: *778 nullable: true sender: *4 required: @@ -156395,11 +156932,11 @@ x-webhooks: - from required: - note - enterprise: *740 - installation: *741 - organization: *742 - project_card: *782 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project_card: *784 + repository: *745 sender: *4 required: - action @@ -156493,9 +157030,9 @@ x-webhooks: - from required: - column_id - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 project_card: allOf: - title: Project Card @@ -156685,7 +157222,7 @@ x-webhooks: type: string required: - after_id - repository: *743 + repository: *745 sender: *4 required: - action @@ -156765,10 +157302,10 @@ x-webhooks: type: string enum: - closed - enterprise: *740 - installation: *741 - organization: *742 - project: &784 + enterprise: *742 + installation: *743 + organization: *744 + project: &786 title: Project type: object properties: @@ -156892,7 +157429,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *743 + repository: *745 sender: *4 required: - action @@ -156972,10 +157509,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - project_column: &783 + enterprise: *742 + installation: *743 + organization: *744 + project_column: &785 title: Project Column type: object properties: @@ -157014,7 +157551,7 @@ x-webhooks: - name - created_at - updated_at - repository: *743 + repository: *745 sender: *4 required: - action @@ -157093,18 +157630,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - project_column: *783 + enterprise: *742 + installation: *743 + organization: *744 + project_column: *785 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *775 - required: *776 + properties: *777 + required: *778 nullable: true sender: *4 required: @@ -157194,11 +157731,11 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 - project_column: *783 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project_column: *785 + repository: *745 sender: *4 required: - action @@ -157278,11 +157815,11 @@ x-webhooks: type: string enum: - moved - enterprise: *740 - installation: *741 - organization: *742 - project_column: *783 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project_column: *785 + repository: *745 sender: *4 required: - action @@ -157362,11 +157899,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - project: *784 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project: *786 + repository: *745 sender: *4 required: - action @@ -157446,18 +157983,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - project: *784 + enterprise: *742 + installation: *743 + organization: *744 + project: *786 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *775 - required: *776 + properties: *777 + required: *778 nullable: true sender: *4 required: @@ -157559,11 +158096,11 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 - project: *784 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project: *786 + repository: *745 sender: *4 required: - action @@ -157642,11 +158179,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *740 - installation: *741 - organization: *742 - project: *784 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + project: *786 + repository: *745 sender: *4 required: - action @@ -157727,9 +158264,9 @@ x-webhooks: type: string enum: - closed - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -157810,9 +158347,9 @@ x-webhooks: type: string enum: - created - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -157893,9 +158430,9 @@ x-webhooks: type: string enum: - deleted - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -158012,9 +158549,9 @@ x-webhooks: type: string to: type: string - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -158097,7 +158634,7 @@ x-webhooks: type: string enum: - archived - changes: &788 + changes: &790 type: object properties: archived_at: @@ -158111,9 +158648,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *741 - organization: *742 - projects_v2_item: &785 + installation: *743 + organization: *744 + projects_v2_item: &787 title: Projects v2 Item description: An item belonging to a project type: object @@ -158131,7 +158668,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *283 + content_type: *285 creator: *4 created_at: type: string @@ -158248,9 +158785,9 @@ x-webhooks: nullable: true to: type: string - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158332,9 +158869,9 @@ x-webhooks: type: string enum: - created - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158415,9 +158952,9 @@ x-webhooks: type: string enum: - deleted - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158523,7 +159060,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &786 + - &788 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -158545,7 +159082,7 @@ x-webhooks: required: - id - name - - &787 + - &789 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -158579,8 +159116,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *786 - - *787 + - *788 + - *789 required: - field_value - type: object @@ -158596,9 +159133,9 @@ x-webhooks: nullable: true required: - body - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158693,9 +159230,9 @@ x-webhooks: to: type: string nullable: true - installation: *741 - organization: *742 - projects_v2_item: *785 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158778,10 +159315,10 @@ x-webhooks: type: string enum: - restored - changes: *788 - installation: *741 - organization: *742 - projects_v2_item: *785 + changes: *790 + installation: *743 + organization: *744 + projects_v2_item: *787 sender: *4 required: - action @@ -158863,9 +159400,9 @@ x-webhooks: type: string enum: - reopened - installation: *741 - organization: *742 - projects_v2: *276 + installation: *743 + organization: *744 + projects_v2: *278 sender: *4 required: - action @@ -158946,14 +159483,14 @@ x-webhooks: type: string enum: - created - installation: *741 - organization: *742 - projects_v2_status_update: &791 + installation: *743 + organization: *744 + projects_v2_status_update: &793 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *789 - required: *790 + properties: *791 + required: *792 sender: *4 required: - action @@ -159034,9 +159571,9 @@ x-webhooks: type: string enum: - deleted - installation: *741 - organization: *742 - projects_v2_status_update: *791 + installation: *743 + organization: *744 + projects_v2_status_update: *793 sender: *4 required: - action @@ -159172,9 +159709,9 @@ x-webhooks: type: string format: date nullable: true - installation: *741 - organization: *742 - projects_v2_status_update: *791 + installation: *743 + organization: *744 + projects_v2_status_update: *793 sender: *4 required: - action @@ -159245,10 +159782,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - repository @@ -159325,13 +159862,13 @@ x-webhooks: type: string enum: - assigned - assignee: *762 - enterprise: *740 - installation: *741 - number: &792 + assignee: *764 + enterprise: *742 + installation: *743 + number: &794 description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -161618,7 +162155,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -161700,11 +162237,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -163986,7 +164523,7 @@ x-webhooks: - draft reason: type: string - repository: *743 + repository: *745 sender: *4 required: - action @@ -164068,11 +164605,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -166354,7 +166891,7 @@ x-webhooks: - draft reason: type: string - repository: *743 + repository: *745 sender: *4 required: - action @@ -166436,13 +166973,13 @@ x-webhooks: type: string enum: - closed - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: &793 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: &795 allOf: - - *596 + - *598 - type: object properties: allow_auto_merge: @@ -166504,7 +167041,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *743 + repository: *745 sender: *4 required: - action @@ -166585,12 +167122,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -166670,11 +167207,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *740 - milestone: *580 - number: *792 - organization: *742 - pull_request: &794 + enterprise: *742 + milestone: *582 + number: *794 + organization: *744 + pull_request: &796 title: Pull Request type: object properties: @@ -168955,7 +169492,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -169034,11 +169571,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -171338,7 +171875,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *743 + repository: *745 sender: *4 required: - action @@ -171462,12 +171999,12 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -171547,11 +172084,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -173836,7 +174373,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -173916,11 +174453,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *740 - installation: *741 - label: *761 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + label: *763 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -176206,7 +176743,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -176287,10 +176824,10 @@ x-webhooks: type: string enum: - locked - enterprise: *740 - installation: *741 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -178574,7 +179111,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -178654,12 +179191,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *740 - milestone: *580 - number: *792 - organization: *742 - pull_request: *794 - repository: *743 + enterprise: *742 + milestone: *582 + number: *794 + organization: *744 + pull_request: *796 + repository: *745 sender: *4 required: - action @@ -178738,12 +179275,12 @@ x-webhooks: type: string enum: - opened - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -178824,12 +179361,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -178909,12 +179446,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *740 - installation: *741 - number: *792 - organization: *742 - pull_request: *793 - repository: *743 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 + pull_request: *795 + repository: *745 sender: *4 required: - action @@ -179280,9 +179817,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: type: object properties: @@ -181456,7 +181993,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *743 + repository: *745 sender: *4 required: - action @@ -181536,7 +182073,7 @@ x-webhooks: type: string enum: - deleted - comment: &796 + comment: &798 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -181821,9 +182358,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: type: object properties: @@ -183985,7 +184522,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *743 + repository: *745 sender: *4 required: - action @@ -184065,11 +184602,11 @@ x-webhooks: type: string enum: - edited - changes: *795 - comment: *796 - enterprise: *740 - installation: *741 - organization: *742 + changes: *797 + comment: *798 + enterprise: *742 + installation: *743 + organization: *744 pull_request: type: object properties: @@ -186234,7 +186771,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *743 + repository: *745 sender: *4 required: - action @@ -186315,9 +186852,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -188494,7 +189031,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 + repository: *745 review: description: The review that was affected. type: object @@ -188741,9 +189278,9 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -190793,8 +191330,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 - review: &797 + repository: *745 + review: &799 description: The review that was affected. type: object properties: @@ -191027,12 +191564,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -193319,7 +193856,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 requested_reviewer: title: User type: object @@ -193403,12 +193940,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -195702,7 +196239,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195894,12 +196431,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -198188,7 +198725,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 requested_reviewer: title: User type: object @@ -198273,12 +198810,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *740 - installation: *741 + enterprise: *742 + installation: *743 number: description: The pull request number. type: integer - organization: *742 + organization: *744 pull_request: title: Pull Request type: object @@ -200558,7 +201095,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 requested_team: title: Team description: Groups of organization members that gives permissions @@ -200739,9 +201276,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -202920,8 +203457,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 - review: *797 + repository: *745 + review: *799 sender: *4 required: - action @@ -203001,9 +203538,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -205091,7 +205628,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 + repository: *745 sender: *4 thread: type: object @@ -205478,9 +206015,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 pull_request: title: Simple Pull Request type: object @@ -207554,7 +208091,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *743 + repository: *745 sender: *4 thread: type: object @@ -207944,10 +208481,10 @@ x-webhooks: type: string before: type: string - enterprise: *740 - installation: *741 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -210222,7 +210759,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -210304,11 +210841,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *798 - enterprise: *740 - installation: *741 - number: *792 - organization: *742 + assignee: *800 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -212595,7 +213132,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -212674,11 +213211,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *740 - installation: *741 - label: *761 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + label: *763 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -214955,7 +215492,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -215036,10 +215573,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *740 - installation: *741 - number: *792 - organization: *742 + enterprise: *742 + installation: *743 + number: *794 + organization: *744 pull_request: title: Pull Request type: object @@ -217308,7 +217845,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *743 + repository: *745 sender: *4 required: - action @@ -217508,7 +218045,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *740 + enterprise: *742 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -217600,8 +218137,8 @@ x-webhooks: - url - author - committer - installation: *741 - organization: *742 + installation: *743 + organization: *744 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -218187,9 +218724,9 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 registry_package: type: object properties: @@ -218635,7 +219172,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -218689,7 +219226,7 @@ x-webhooks: - owner - package_version - registry - repository: *743 + repository: *745 sender: *4 required: - action @@ -218767,9 +219304,9 @@ x-webhooks: type: string enum: - updated - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 registry_package: type: object properties: @@ -219077,7 +219614,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *779 + items: *781 summary: type: string tag_name: @@ -219126,7 +219663,7 @@ x-webhooks: - owner - package_version - registry - repository: *743 + repository: *745 sender: *4 required: - action @@ -219203,10 +219740,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - release: &799 + enterprise: *742 + installation: *743 + organization: *744 + release: &801 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219524,7 +220061,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *743 + repository: *745 sender: *4 required: - action @@ -219601,11 +220138,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - release: *799 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + release: *801 + repository: *745 sender: *4 required: - action @@ -219722,11 +220259,11 @@ x-webhooks: type: boolean required: - to - enterprise: *740 - installation: *741 - organization: *742 - release: *799 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + release: *801 + repository: *745 sender: *4 required: - action @@ -219804,9 +220341,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -220128,7 +220665,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *743 + repository: *745 sender: *4 required: - action @@ -220204,10 +220741,10 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 - release: &800 + enterprise: *742 + installation: *743 + organization: *744 + release: &802 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -220526,7 +221063,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *743 + repository: *745 sender: *4 required: - action @@ -220602,11 +221139,11 @@ x-webhooks: type: string enum: - released - enterprise: *740 - installation: *741 - organization: *742 - release: *799 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + release: *801 + repository: *745 sender: *4 required: - action @@ -220682,11 +221219,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *740 - installation: *741 - organization: *742 - release: *800 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + release: *802 + repository: *745 sender: *4 required: - action @@ -220762,11 +221299,11 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_advisory: *663 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_advisory: *665 sender: *4 required: - action @@ -220842,11 +221379,11 @@ x-webhooks: type: string enum: - reported - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_advisory: *663 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_advisory: *665 sender: *4 required: - action @@ -220922,10 +221459,10 @@ x-webhooks: type: string enum: - archived - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221002,10 +221539,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221083,10 +221620,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221170,10 +221707,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221285,10 +221822,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221360,10 +221897,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 status: type: string @@ -221444,10 +221981,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221524,10 +222061,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221621,10 +222158,10 @@ x-webhooks: - name required: - repository - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -221704,11 +222241,11 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_ruleset: *324 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_ruleset: *326 sender: *4 required: - action @@ -221786,11 +222323,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_ruleset: *324 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_ruleset: *326 sender: *4 required: - action @@ -221868,11 +222405,11 @@ x-webhooks: type: string enum: - edited - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - repository_ruleset: *324 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + repository_ruleset: *326 changes: type: object properties: @@ -221891,16 +222428,16 @@ x-webhooks: properties: added: type: array - items: *298 + items: *300 deleted: type: array - items: *298 + items: *300 updated: type: array items: type: object properties: - condition: *298 + condition: *300 changes: type: object properties: @@ -221933,16 +222470,16 @@ x-webhooks: properties: added: type: array - items: *616 + items: *618 deleted: type: array - items: *616 + items: *618 updated: type: array items: type: object properties: - rule: *616 + rule: *618 changes: type: object properties: @@ -222176,10 +222713,10 @@ x-webhooks: - from required: - owner - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222257,10 +222794,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222338,7 +222875,7 @@ x-webhooks: type: string enum: - create - alert: &801 + alert: &803 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -222460,10 +222997,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222669,10 +223206,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222750,11 +223287,11 @@ x-webhooks: type: string enum: - reopen - alert: *801 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *803 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -222953,10 +223490,10 @@ x-webhooks: enum: - fixed - open - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223034,11 +223571,11 @@ x-webhooks: type: string enum: - assigned - alert: &802 + alert: &804 type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -223046,8 +223583,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri @@ -223177,10 +223714,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223258,11 +223795,11 @@ x-webhooks: type: string enum: - created - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223343,11 +223880,11 @@ x-webhooks: type: string enum: - created - alert: *802 - installation: *741 - location: *803 - organization: *742 - repository: *743 + alert: *804 + installation: *743 + location: *805 + organization: *744 + repository: *745 sender: *4 required: - location @@ -223585,11 +224122,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223667,11 +224204,11 @@ x-webhooks: type: string enum: - reopened - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223749,11 +224286,11 @@ x-webhooks: type: string enum: - resolved - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223831,12 +224368,12 @@ x-webhooks: type: string enum: - unassigned - alert: *802 + alert: *804 assignee: *4 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -223914,11 +224451,11 @@ x-webhooks: type: string enum: - validated - alert: *802 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + alert: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -224044,10 +224581,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *743 - enterprise: *740 - installation: *741 - organization: *742 + repository: *745 + enterprise: *742 + installation: *743 + organization: *744 sender: *4 required: - action @@ -224125,11 +224662,11 @@ x-webhooks: type: string enum: - published - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - security_advisory: &804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + security_advisory: &806 description: The details of the security advisory, including summary, description, and severity. type: object @@ -224300,11 +224837,11 @@ x-webhooks: type: string enum: - updated - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 - security_advisory: *804 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 + security_advisory: *806 sender: *4 required: - action @@ -224377,10 +224914,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -224552,11 +225089,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *297 - enterprise: *740 - installation: *741 - organization: *742 - repository: *345 + security_and_analysis: *299 + enterprise: *742 + installation: *743 + organization: *744 + repository: *347 sender: *4 required: - changes @@ -224634,12 +225171,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: &805 + sponsorship: &807 type: object properties: created_at: @@ -224940,12 +225477,12 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - sponsorship @@ -225033,12 +225570,12 @@ x-webhooks: type: string required: - from - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - changes @@ -225115,17 +225652,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &806 + effective_date: &808 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - sponsorship @@ -225199,7 +225736,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &807 + changes: &809 type: object properties: tier: @@ -225243,13 +225780,13 @@ x-webhooks: - from required: - tier - effective_date: *806 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + effective_date: *808 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - changes @@ -225326,13 +225863,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *807 - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + changes: *809 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - sponsorship: *805 + sponsorship: *807 required: - action - changes @@ -225406,10 +225943,10 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225492,10 +226029,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225915,15 +226452,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *740 + enterprise: *742 id: description: The unique identifier of the status. type: integer - installation: *741 + installation: *743 name: type: string - organization: *742 - repository: *743 + organization: *744 + repository: *745 sender: *4 sha: description: The Commit SHA. @@ -226032,15 +226569,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - parent_issue_repo: *80 + parent_issue: *88 + parent_issue_repo: *82 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - installation: *741 - organization: *742 - repository: *743 + sub_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -226124,15 +226661,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - parent_issue_repo: *80 + parent_issue: *88 + parent_issue_repo: *82 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - installation: *741 - organization: *742 - repository: *743 + sub_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -226216,15 +226753,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - sub_issue_repo: *80 + sub_issue: *88 + sub_issue_repo: *82 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - installation: *741 - organization: *742 - repository: *743 + parent_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -226308,15 +226845,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - sub_issue_repo: *80 + sub_issue: *88 + sub_issue_repo: *82 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - installation: *741 - organization: *742 - repository: *743 + parent_issue: *88 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -226393,12 +226930,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - team: &808 + team: &810 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -226621,9 +227158,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -227081,7 +227618,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - team @@ -227157,9 +227694,9 @@ x-webhooks: type: string enum: - created - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -227617,7 +228154,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - team @@ -227694,9 +228231,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -228154,7 +228691,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - team @@ -228298,9 +228835,9 @@ x-webhooks: - from required: - permissions - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -228758,7 +229295,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - changes @@ -228836,9 +229373,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *740 - installation: *741 - organization: *742 + enterprise: *742 + installation: *743 + organization: *744 repository: title: Repository description: A git repository @@ -229296,7 +229833,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *808 + team: *810 required: - action - team @@ -229372,10 +229909,10 @@ x-webhooks: type: string enum: - started - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 required: - action @@ -229448,16 +229985,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *740 + enterprise: *742 inputs: type: object nullable: true additionalProperties: true - installation: *741 - organization: *742 + installation: *743 + organization: *744 ref: type: string - repository: *743 + repository: *745 sender: *4 workflow: type: string @@ -229539,10 +230076,10 @@ x-webhooks: type: string enum: - completed - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 workflow_job: allOf: @@ -229779,7 +230316,7 @@ x-webhooks: type: string required: - conclusion - deployment: *506 + deployment: *508 required: - action - repository @@ -229858,10 +230395,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 workflow_job: allOf: @@ -230121,7 +230658,7 @@ x-webhooks: required: - status - steps - deployment: *506 + deployment: *508 required: - action - repository @@ -230200,10 +230737,10 @@ x-webhooks: type: string enum: - queued - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 workflow_job: type: object @@ -230338,7 +230875,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *506 + deployment: *508 required: - action - repository @@ -230417,10 +230954,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 workflow_job: type: object @@ -230556,7 +231093,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *506 + deployment: *508 required: - action - repository @@ -230636,12 +231173,12 @@ x-webhooks: type: string enum: - completed - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: *757 + workflow: *759 workflow_run: title: Workflow Run type: object @@ -231640,12 +232177,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: *757 + workflow: *759 workflow_run: title: Workflow Run type: object @@ -232629,12 +233166,12 @@ x-webhooks: type: string enum: - requested - enterprise: *740 - installation: *741 - organization: *742 - repository: *743 + enterprise: *742 + installation: *743 + organization: *744 + repository: *745 sender: *4 - workflow: *757 + workflow: *759 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 738780d88f..568cb1dc85 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -25222,17 +25226,17 @@ } } }, - "/enterprises/{enterprise}/teams": { + "/enterprises/{enterprise}/dependabot/repository-access": { "get": { - "summary": "List enterprise teams", - "description": "List all teams in the enterprise for the authenticated user", + "summary": "Lists the repositories Dependabot can access in an enterprise", + "description": "Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", "tags": [ - "enterprise-teams" + "dependabot" ], - "operationId": "enterprise-teams/list", + "operationId": "dependabot/repository-access-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" }, "parameters": [ { @@ -25245,21 +25249,26 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "page", "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { "type": "integer", - "default": 30 + "minimum": 1, + "default": 1 } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "per_page", "in": "query", + "description": "Number of results per page.", + "required": false, "schema": { "type": "integer", - "default": 1 + "minimum": 1, + "maximum": 100, + "default": 30 } } ], @@ -25269,106 +25278,1000 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "example": "disabled | all" - }, - "organization_selection_type": { - "type": "string", - "example": "disabled | selected | all" - }, - "group_id": { - "nullable": true, - "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "group_name": { - "nullable": true, - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "example": "Justice League" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/dc/teams/justice-league" - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" - ] - } + "accessible_repositories": { + "type": "array", + "items": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "nullable": true + } + } + }, + "additionalProperties": false }, "examples": { "default": { - "value": [ - { - "id": 1, - "name": "Justice League", - "description": "A great team.", - "slug": "justice-league", - "url": "https://api.github.com/enterprises/dc/teams/justice-league", - "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", - "html_url": "https://github.com/enterprises/dc/teams/justice-league", - "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", - "created_at": "2019-01-26T19:01:12Z", - "updated_at": "2019-01-26T19:14:43Z" - } - ] + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an enterprise", + "description": "Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot in an enterprise", + "description": "Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/teams": { + "get": { + "summary": "List enterprise teams", + "description": "List all teams in the enterprise for the authenticated user", + "tags": [ + "enterprise-teams" + ], + "operationId": "enterprise-teams/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "example": "disabled | all" + }, + "organization_selection_type": { + "type": "string", + "example": "disabled | selected | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" + }, + "group_name": { + "nullable": true, + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "example": "Justice League" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Justice League", + "description": "A great team.", + "slug": "justice-league", + "url": "https://api.github.com/enterprises/dc/teams/justice-league", + "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", + "html_url": "https://github.com/enterprises/dc/teams/justice-league", + "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", + "created_at": "2019-01-26T19:01:12Z", + "updated_at": "2019-01-26T19:14:43Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, "403": { @@ -79244,6 +80147,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -79307,6 +80214,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -102315,6 +103226,9 @@ "schema": { "type": "object", "additionalProperties": false, + "required": [ + "selected_repository_ids" + ], "properties": { "selected_repository_ids": { "type": "array", @@ -238571,6 +239485,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -238738,6 +239660,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -257298,6 +258224,11 @@ { "op": "remove", "path": "/requestBody/content/application~1json/schema/properties/return_run_details" + }, + { + "op": "replace", + "path": "/responses/200/description", + "value": "Response including the workflow run ID and URLs." } ], "version": "2026-03-10" @@ -544246,6 +545177,15 @@ "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", "type": "string", "nullable": true + }, + "validity": { + "type": "string", + "nullable": true, + "enum": [ + "active", + "inactive" + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -545493,7 +546433,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "description": "Service unavailable", @@ -966277,567 +967217,8191 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "type": "object", + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null, + "template_repository": { + "properties": { + "use_squash_pr_title_as_default": null + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null, + "template_repository": { + "properties": { + "use_squash_pr_title_as_default": null + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-demilestoned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues demilestoned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "demilestoned" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "pinned_at", - "pinned_by" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" ], - "nullable": true + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ "id", "node_id", + "owner", + "name", + "description", + "external_url", "html_url", - "issue_url", - "user", - "url", "created_at", - "updated_at" - ], - "nullable": true + "updated_at", + "permissions", + "events" + ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "total": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { "type": "integer" }, - "completed": { + "+1": { "type": "integer" }, - "percent_completed": { + "-1": { "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { + }, + "laugh": { "type": "integer" }, - "blocking": { + "confused": { "type": "integer" }, - "total_blocked_by": { + "heart": { "type": "integer" }, - "total_blocking": { + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { "type": "integer" } }, "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", + "pin": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", + "id": { + "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, - "node_id": { + "name": { + "description": "The name of the option", "type": "string", - "example": "IFT_GDKND" + "example": "High" }, - "data_type": { - "description": "The data type of the issue field", + "color": { + "description": "The color of the option", "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true + "example": "red" } }, "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] + "id", + "name", + "color" + ], + "nullable": true } }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "state_reason": { + "node_id": { "type": "string", - "nullable": true + "description": "The node identifier of the issue type." }, - "timeline_url": { + "name": { "type": "string", - "format": "uri" + "description": "The name of the issue type." }, - "title": { - "description": "Title of the issue", - "type": "string" + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, - "updated_at": { + "created_at": { "type": "string", + "description": "The time the issue type created.", "format": "date-time" }, - "url": { - "description": "URL for the issue", + "updated_at": { "type": "string", - "format": "uri" + "description": "The time the issue type last updated.", + "format": "date-time" }, - "user": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "name", + "description" ] }, - { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "active_lock_reason": { + "avatar_url": { "type": "string", - "nullable": true + "format": "uri" }, - "assignee": { - "type": "object", - "nullable": true + "deleted": { + "type": "boolean" }, - "assignees": { - "type": "array", - "items": { - "type": "object", - "nullable": true - } + "email": { + "type": "string", + "nullable": true }, - "author_association": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "body": { + "followers_url": { "type": "string", - "nullable": true + "format": "uri" }, - "closed_at": { + "following_url": { "type": "string", - "nullable": true + "format": "uri-template" }, - "comments": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "comments_url": { + "gravatar_id": { "type": "string" }, - "created_at": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, - "events_url": { + "name": { "type": "string" }, - "html_url": { + "node_id": { "type": "string" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "labels": { - "type": "array", - "items": { - "type": "object", - "nullable": true - } + "received_events_url": { + "type": "string", + "format": "uri" }, - "labels_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "locked": { + "site_admin": { "type": "boolean" }, - "milestone": { - "type": "object", - "nullable": true + "starred_url": { + "type": "string", + "format": "uri-template" }, - "node_id": { + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { "type": "string" + } + } + } + } + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "number": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "performed_via_github_app": { - "type": "object", + "email": { + "type": "string", "nullable": true }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } + "events_url": { + "type": "string", + "format": "uri-template" }, - "repository_url": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "state": { + "html_url": { "type": "string", - "enum": [ - "closed", - "open" - ] + "format": "uri" }, - "timeline_url": { + "id": { + "type": "integer" + }, + "login": { "type": "string" }, - "title": { + "name": { "type": "string" }, - "updated_at": { + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user_view_type": { - "type": "string" - } - } + "user_view_type": { + "type": "string" } }, "required": [ - "state", - "closed_at" + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -968321,11 +976885,11 @@ } } }, - "issues-deleted": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -968392,15 +976956,45 @@ "content": { "application/json": { "schema": { - "title": "issues deleted event", + "title": "issues edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "edited" ] }, + "changes": { + "description": "The changes to the issue.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -968585,7 +977179,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -968682,15 +977277,13 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } }, "required": [ @@ -968898,7 +977491,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -969056,6 +977650,8 @@ "watch", "workflow_dispatch", "workflow_run", + "security_and_analysis", + "pull_request_review_thread", "reminder" ] } @@ -969303,7 +977899,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -970367,10 +978964,6 @@ "type": "string", "format": "uri" }, - "title": { - "description": "Title of the issue", - "type": "string" - }, "type": { "title": "Issue Type", "description": "The type of issue.", @@ -970431,6 +979024,10 @@ "description" ] }, + "title": { + "description": "Title of the issue", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time" @@ -970520,7 +979117,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -970561,6 +979159,47 @@ "reactions" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -972017,6 +980656,7 @@ }, "required": [ "action", + "changes", "issue", "repository", "sender" @@ -972042,11 +980682,11 @@ } } }, - "issues-demilestoned": { + "issues-field-added": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue field value was set or updated on an issue.", + "operationId": "issues/field-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -972113,13 +980753,13 @@ "content": { "application/json": { "schema": { - "title": "issues demilestoned event", + "title": "issues field_added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "demilestoned" + "field_added" ] }, "enterprise": { @@ -972215,29 +980855,6 @@ "title": "Issue", "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", "type": "object", - "required": [ - "active_lock_reason", - "assignees", - "author_association", - "body", - "closed_at", - "comments", - "comments_url", - "created_at", - "events_url", - "html_url", - "id", - "labels_url", - "milestone", - "node_id", - "number", - "reactions", - "repository_url", - "title", - "updated_at", - "url", - "user" - ], "properties": { "active_lock_reason": { "type": "string", @@ -972254,10 +980871,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -972340,8 +980953,15 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "assignees": { "type": "array", @@ -972349,10 +980969,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -972435,8 +981051,15 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "login", + "id" + ] } }, "author_association": { @@ -972495,16 +981118,6 @@ "items": { "title": "Label", "type": "object", - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ], - "nullable": true, "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", @@ -972532,7 +981145,16 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] } }, "labels_url": { @@ -972547,24 +981169,6 @@ "description": "A collection of related issues and pull requests.", "type": "object", "nullable": true, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ], "properties": { "closed_at": { "type": "string", @@ -972582,10 +981186,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -972672,7 +981272,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "description": { "type": "string", @@ -972724,7 +981328,25 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, "node_id": { "type": "string" @@ -972737,17 +981359,6 @@ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ], "properties": { "created_at": { "type": "string", @@ -972808,7 +981419,9 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run" + "workflow_run", + "reminder", + "pull_request_review_thread" ] } }, @@ -972837,10 +981450,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -972926,7 +981535,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "permissions": { "description": "The set of permissions for the GitHub app", @@ -973182,7 +981795,18 @@ "nullable": true, "format": "date-time" } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] }, "pull_request": { "type": "object", @@ -973213,18 +981837,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -973257,7 +981869,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "repository_url": { "type": "string", @@ -974186,10 +982810,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -974277,193 +982897,183 @@ "user_view_type": { "type": "string" } - } - } - } - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } }, "required": [ "login", "id" ] - }, - "description": { - "type": "string", - "nullable": true - }, - "due_on": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was set or updated on the issue.", + "properties": { "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue field." }, - "labels_url": { + "name": { "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" + "description": "The name of the issue field." }, - "state": { - "description": "The state of the milestone.", + "field_type": { "type": "string", + "description": "The data type of the issue field.", "enum": [ - "open", - "closed" + "text", + "date", + "single_select", + "number" ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was set or updated for the issue field. When updating an existing value, the previous value is available in `changes`.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] }, - "updated_at": { - "type": "string", - "format": "date-time" + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." }, - "url": { - "type": "string", - "format": "uri" + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } } }, "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" + "id" ] }, + "changes": { + "type": "object", + "description": "The previous field value, present when an existing value was updated.", + "properties": { + "issue_field_value": { + "type": "object", + "description": "The previous issue field value data.", + "properties": { + "from": { + "type": "object", + "description": "The previous value of the issue field before the update.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The previous value. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the previously selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The previously selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "from" + ] + } + } + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -975921,6 +984531,7 @@ "required": [ "action", "issue", + "issue_field", "repository", "sender" ] @@ -975945,11 +984556,11 @@ } } }, - "issues-edited": { + "issues-field-removed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue field value was cleared from an issue.", + "operationId": "issues/field-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" }, @@ -976016,45 +984627,15 @@ "content": { "application/json": { "schema": { - "title": "issues edited event", + "title": "issues field_removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "field_removed" ] }, - "changes": { - "description": "The changes to the issue.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "title": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the title.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -976344,6 +984925,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -976710,9 +985294,8 @@ "watch", "workflow_dispatch", "workflow_run", - "security_and_analysis", - "pull_request_review_thread", - "reminder" + "reminder", + "pull_request_review_thread" ] } }, @@ -978024,6 +986607,10 @@ "type": "string", "format": "uri" }, + "title": { + "description": "Title of the issue", + "type": "string" + }, "type": { "title": "Issue Type", "description": "The type of issue.", @@ -978084,10 +986671,6 @@ "description" ] }, - "title": { - "description": "Title of the issue", - "type": "string" - }, "updated_at": { "type": "string", "format": "date-time" @@ -978219,45 +986802,84 @@ "reactions" ] }, - "label": { - "title": "Label", + "issue_field": { "type": "object", + "description": "The issue field whose value was cleared from the issue.", "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": "string", - "nullable": true - }, "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue field." }, "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" + "type": "string", + "description": "The name of the issue field." }, - "url": { - "description": "URL for the label", + "field_type": { "type": "string", - "format": "uri" + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] } }, "required": [ "id", - "node_id", - "url", "name", - "color", - "default", - "description" + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was cleared from the issue field.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" ] }, "organization": { @@ -979716,8 +988338,8 @@ }, "required": [ "action", - "changes", "issue", + "issue_field", "repository", "sender" ] diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index ecd1020040..caf230f75b 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -73,6 +73,9 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot @@ -881,7 +884,7 @@ paths: - subscriptions_url - type - url - type: &332 + type: &334 type: string description: The type of credit the user is receiving. enum: @@ -1041,7 +1044,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &129 + schema: &131 title: Validation Error Simple description: Validation Error Simple type: object @@ -1074,7 +1077,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &668 + - &670 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1198,7 +1201,7 @@ paths: GitHub. type: object nullable: true - properties: &81 + properties: &83 id: description: Unique identifier of the GitHub app example: 37 @@ -1331,7 +1334,7 @@ paths: about itself. example: 5 type: integer - required: &82 + required: &84 - id - node_id - owner @@ -1636,7 +1639,7 @@ paths: schema: type: integer default: 30 - - &217 + - &219 name: cursor 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 @@ -1645,7 +1648,7 @@ paths: required: false schema: type: string - - &218 + - &220 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1665,7 +1668,7 @@ paths: application/json: schema: type: array - items: &219 + items: &221 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1745,7 +1748,7 @@ paths: - installation_id - repository_id examples: - default: &220 + default: &222 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1804,7 +1807,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &128 + schema: &130 title: Validation Error description: Validation Error type: object @@ -1873,7 +1876,7 @@ paths: description: Response content: application/json: - schema: &221 + schema: &223 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1987,7 +1990,7 @@ paths: - request - response examples: - default: &222 + default: &224 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2188,7 +2191,7 @@ paths: parameters: - *17 - *19 - - &93 + - &95 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2771,7 +2774,7 @@ paths: suspended_at: suspended_by: headers: - Link: &68 + Link: &70 example: ; rel="next", ; rel="last" schema: @@ -2968,11 +2971,11 @@ paths: - selected repositories: type: array - items: &80 + items: &82 title: Repository description: A repository on GitHub. type: object - properties: &296 + properties: &298 id: description: Unique identifier of the repository example: 42 @@ -2992,7 +2995,7 @@ paths: title: License Simple description: License Simple type: object - properties: &89 + properties: &91 key: type: string example: mit @@ -3014,7 +3017,7 @@ paths: html_url: type: string format: uri - required: &90 + required: &92 - key - name - url @@ -3423,7 +3426,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &297 + required: &299 - archive_url - assignees_url - blobs_url @@ -3497,7 +3500,7 @@ paths: - watchers_count - created_at - updated_at - x-github-breaking-changes: &298 + x-github-breaking-changes: &300 - changeset: remove_use_squash_pr_title_as_default patch: properties: @@ -7453,7 +7456,7 @@ paths: required: true content: application/json: - schema: &141 + schema: &143 title: Actions OIDC Custom Property Inclusion Input description: Input for creating an OIDC custom property inclusion type: object @@ -8153,7 +8156,7 @@ paths: description: Response content: application/json: - schema: &188 + schema: &190 type: array description: A list of default code security configurations items: @@ -8169,7 +8172,7 @@ paths: default configuration: *49 examples: - default: &189 + default: &191 value: - default_for_new_repos: public configuration: @@ -8631,7 +8634,7 @@ paths: default: value: default_for_new_repos: all - configuration: &187 + configuration: &189 value: id: 1325 target_type: organization @@ -8721,7 +8724,7 @@ paths: application/json: schema: type: array - items: &190 + items: &192 type: object description: Repositories associated with a code security configuration and attachment status @@ -8743,7 +8746,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &208 + properties: &68 id: type: integer format: int64 @@ -8970,7 +8973,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &209 + required: &69 - archive_url - assignees_url - blobs_url @@ -9022,7 +9025,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &191 + repository: &193 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -9527,7 +9530,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &197 + - &199 name: classification in: query description: |- @@ -9536,7 +9539,7 @@ paths: Can be: `malware`, `general` schema: type: string - - &198 + - &200 name: state in: query description: |- @@ -9545,7 +9548,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &199 + - &201 name: severity in: query description: |- @@ -9554,7 +9557,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &200 + - &202 name: ecosystem in: query description: |- @@ -9563,14 +9566,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &201 + - &203 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &202 + - &204 name: epss_percentage in: query description: |- @@ -9582,7 +9585,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &497 + - &499 name: has in: query description: |- @@ -9596,7 +9599,7 @@ paths: type: string enum: - patch - - &203 + - &205 name: assignee in: query description: |- @@ -9605,7 +9608,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &204 + - &206 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9615,7 +9618,7 @@ paths: enum: - development - runtime - - &205 + - &207 name: sort in: query description: |- @@ -9641,11 +9644,11 @@ paths: application/json: schema: type: array - items: &206 + items: &208 type: object description: A Dependabot alert. properties: - number: &177 + number: &179 type: integer description: The security alert number. readOnly: true @@ -9708,7 +9711,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &498 + security_advisory: &500 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9937,29 +9940,29 @@ paths: - withdrawn_at version: '2026-03-10' security_vulnerability: *66 - url: &180 + url: &182 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &181 + html_url: &183 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &178 + created_at: &180 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &179 + updated_at: &181 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &183 + dismissed_at: &185 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9989,21 +9992,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &182 + fixed_at: &184 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &499 + auto_dismissed_at: &501 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &500 + dismissal_request: &502 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -10065,7 +10068,7 @@ paths: - repository additionalProperties: false examples: - default: &207 + default: &209 value: - number: 2 state: dismissed @@ -10413,6 +10416,266 @@ paths: previews: [] category: dependabot subcategory: alerts + "/enterprises/{enterprise}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an enterprise + description: |- + Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise + parameters: + - *40 + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: &210 + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able + to access in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + title: Simple Repository + description: A GitHub repository. + type: object + properties: *68 + required: *69 + nullable: true + additionalProperties: false + examples: + default: &211 + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an enterprise + description: |- + Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise + parameters: + - *40 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + "/enterprises/{enterprise}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot in an enterprise + description: |- + Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise + parameters: + - *40 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -10434,7 +10697,7 @@ paths: application/json: schema: type: array - items: &69 + items: &71 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -10505,7 +10768,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -10578,9 +10841,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: &77 + default: &79 value: id: 1 name: Justice League @@ -10609,7 +10872,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *40 - - &70 + - &72 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -10628,7 +10891,7 @@ paths: type: array items: *4 examples: - default: &71 + default: &73 value: - login: octocat id: 1 @@ -10649,7 +10912,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10667,7 +10930,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10698,7 +10961,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10716,7 +10979,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10747,7 +11010,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10765,8 +11028,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *40 - - *70 - - &72 + - *72 + - &74 name: username description: The handle for the GitHub user account. in: path @@ -10780,7 +11043,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &73 + exampleKey1: &75 value: login: octocat id: 1 @@ -10816,8 +11079,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *40 - - *70 - *72 + - *74 responses: '201': description: Successfully added team member @@ -10825,7 +11088,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *73 + exampleKey1: *75 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10843,8 +11106,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *40 - - *70 - *72 + - *74 responses: '204': description: Response @@ -10866,7 +11129,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *40 - - *70 + - *72 - *17 - *19 responses: @@ -10876,11 +11139,11 @@ paths: application/json: schema: type: array - items: &74 + items: &76 title: Organization Simple description: A GitHub organization. type: object - properties: &193 + properties: &195 login: type: string example: github @@ -10921,7 +11184,7 @@ paths: type: string example: A great organization nullable: true - required: &194 + required: &196 - login - url - id @@ -10935,7 +11198,7 @@ paths: - avatar_url - description examples: - default: &75 + default: &77 value: login: github id: 1 @@ -10966,7 +11229,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -10994,9 +11257,9 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: &117 + default: &119 value: - login: github id: 1 @@ -11027,7 +11290,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *40 - - *70 + - *72 requestBody: required: true content: @@ -11068,8 +11331,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *40 - - *70 - - &76 + - *72 + - &78 name: org description: The organization name. The name is not case sensitive. in: path @@ -11081,9 +11344,9 @@ paths: description: The team is assigned to the organization content: application/json: - schema: *74 + schema: *76 examples: - default: *75 + default: *77 '404': description: The team is not assigned to the organization x-github: @@ -11102,16 +11365,16 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *40 - - *70 - - *76 + - *72 + - *78 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *74 + schema: *76 examples: - default: *75 + default: *77 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11128,8 +11391,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *40 - - *70 - - *76 + - *72 + - *78 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -11153,7 +11416,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *40 - - &78 + - &80 name: team_slug description: The slug of the team name. in: path @@ -11165,11 +11428,11 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: *77 + default: *79 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -11187,7 +11450,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *40 - - *78 + - *80 requestBody: required: true content: @@ -11242,11 +11505,11 @@ paths: description: Response content: application/json: - schema: *69 + schema: *71 examples: - default: *77 + default: *79 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -11267,7 +11530,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *40 - - *78 + - *80 responses: '204': description: Response @@ -11305,7 +11568,7 @@ paths: application/json: schema: type: array - items: &112 + items: &114 title: Event description: Event type: object @@ -11315,7 +11578,7 @@ paths: type: type: string nullable: true - actor: &79 + actor: &81 title: Actor description: Actor type: object @@ -11355,7 +11618,7 @@ paths: - id - name - url - org: *79 + org: *81 payload: oneOf: - title: CreateEvent @@ -11401,7 +11664,7 @@ paths: properties: action: type: string - discussion: &761 + discussion: &763 title: Discussion description: A Discussion in a repository. type: object @@ -11688,7 +11951,7 @@ paths: - id labels: type: array - items: &85 + items: &87 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -11763,12 +12026,12 @@ paths: properties: action: type: string - issue: &86 + issue: &88 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &552 + properties: &554 id: type: integer format: int64 @@ -11881,7 +12144,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &280 + properties: &282 url: type: string format: uri @@ -11951,7 +12214,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &281 + required: &283 - closed_issues - creator - description @@ -12030,7 +12293,7 @@ paths: timeline_url: type: string format: uri - type: &243 + type: &245 title: Issue Type description: The type of issue. type: object @@ -12080,7 +12343,7 @@ paths: - node_id - name - description - repository: *80 + repository: *82 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -12091,9 +12354,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - author_association: &83 + properties: *83 + required: *84 + author_association: &85 title: author_association type: string example: OWNER @@ -12108,7 +12371,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &84 + reactions: &86 title: Reaction Rollup type: object properties: @@ -12144,7 +12407,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &679 + sub_issues_summary: &681 title: Sub-issues Summary type: object properties: @@ -12169,7 +12432,7 @@ paths: description: Comments provide a way for people to collaborate on an issue. type: object - properties: &87 + properties: &89 id: description: Unique identifier of the issue comment example: 42 @@ -12212,7 +12475,7 @@ paths: issue_url: type: string format: uri - author_association: *83 + author_association: *85 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend @@ -12223,15 +12486,15 @@ paths: class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - reactions: *84 + properties: *83 + required: *84 + reactions: *86 pin: title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &576 + properties: &578 pinned_at: type: string format: date-time @@ -12243,11 +12506,11 @@ paths: properties: *20 required: *21 nullable: true - required: &577 + required: &579 - pinned_at - pinned_by nullable: true - required: &88 + required: &90 - id - node_id - html_url @@ -12257,7 +12520,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &680 + issue_dependencies_summary: &682 title: Issue Dependencies Summary type: object properties: @@ -12276,7 +12539,7 @@ paths: - total_blocking issue_field_values: type: array - items: &560 + items: &562 title: Issue Field Value description: A value assigned to an issue field type: object @@ -12337,7 +12600,7 @@ paths: - node_id - data_type - value - required: &553 + required: &555 - assignee - closed_at - comments @@ -12358,7 +12621,7 @@ paths: - user - created_at - updated_at - x-github-breaking-changes: &554 + x-github-breaking-changes: &556 - changeset: deprecate_beta_media_type patch: properties: @@ -12405,10 +12668,10 @@ paths: assignees: type: array items: *4 - label: *85 + label: *87 labels: type: array - items: *85 + items: *87 required: - action - issue @@ -12417,14 +12680,14 @@ paths: properties: action: type: string - issue: *86 - comment: &548 + issue: *88 + comment: &550 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 required: - action - issue @@ -12597,8 +12860,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true allow_forking: type: boolean @@ -12687,7 +12950,7 @@ paths: type: string number: type: integer - pull_request: &91 + pull_request: &93 title: Pull Request Minimal type: object properties: @@ -12758,10 +13021,10 @@ paths: assignees: type: array items: *4 - label: *85 + label: *87 labels: type: array - items: *85 + items: *87 required: - action - number @@ -12771,7 +13034,7 @@ paths: properties: action: type: string - pull_request: *91 + pull_request: *93 comment: type: object properties: @@ -13022,7 +13285,7 @@ paths: - pull_request updated_at: type: string - pull_request: *91 + pull_request: *93 required: - action - review @@ -13071,7 +13334,7 @@ paths: updated_at: type: string format: date-time - reactions: *84 + reactions: *86 required: - action - comment @@ -13082,7 +13345,7 @@ paths: type: string release: allOf: - - &610 + - &612 title: Release description: A release. type: object @@ -13153,7 +13416,7 @@ paths: author: *4 assets: type: array - items: &611 + items: &613 title: Release Asset description: Data related to a release. type: object @@ -13228,7 +13491,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *84 + reactions: *86 required: - assets_url - upload_url @@ -13320,7 +13583,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': &120 + '503': &122 description: Service unavailable content: application/json: @@ -13413,7 +13676,7 @@ paths: _links: type: object properties: - timeline: &92 + timeline: &94 title: Link With Type description: Hypermedia Link with Type type: object @@ -13425,17 +13688,17 @@ paths: required: - href - type - user: *92 - security_advisories: *92 - current_user: *92 - current_user_public: *92 - current_user_actor: *92 - current_user_organization: *92 + user: *94 + security_advisories: *94 + current_user: *94 + current_user_public: *94 + current_user_actor: *94 + current_user_organization: *94 current_user_organizations: type: array - items: *92 - repository_discussions: *92 - repository_discussions_category: *92 + items: *94 + repository_discussions: *94 + repository_discussions_category: *94 required: - timeline - user @@ -13497,7 +13760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *93 + - *95 - *17 - *19 responses: @@ -13507,7 +13770,7 @@ paths: application/json: schema: type: array - items: &94 + items: &96 title: Base Gist description: Base Gist type: object @@ -13635,7 +13898,7 @@ paths: path: "/properties/history" version: '2026-03-10' examples: - default: &95 + default: &97 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -13680,7 +13943,7 @@ paths: site_admin: false truncated: false headers: - Link: *68 + Link: *70 '304': *37 '403': *29 x-github: @@ -13756,7 +14019,7 @@ paths: description: Response content: application/json: - schema: &96 + schema: &98 title: Gist Simple description: Gist Simple type: object @@ -13773,7 +14036,7 @@ paths: url: type: string format: uri - user: &686 + user: &688 title: Public User description: Public User type: object @@ -14143,7 +14406,7 @@ paths: path: "/properties/history" version: '2026-03-10' examples: - default: &97 + default: &99 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -14247,7 +14510,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *93 + - *95 - *17 - *19 responses: @@ -14257,11 +14520,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '403': *29 @@ -14281,7 +14544,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *93 + - *95 - *17 - *19 responses: @@ -14291,11 +14554,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '401': *25 '304': *37 '403': *29 @@ -14320,7 +14583,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &98 + - &100 name: gist_id description: The unique identifier of the gist. in: path @@ -14332,10 +14595,10 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - default: *97 - '403': &101 + default: *99 + '403': &103 description: Forbidden Gist content: application/json: @@ -14382,7 +14645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *98 + - *100 requestBody: required: true content: @@ -14442,9 +14705,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - updateGist: *97 + updateGist: *99 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -14602,7 +14865,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -14630,7 +14893,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *98 + - *100 - *17 - *19 responses: @@ -14640,7 +14903,7 @@ paths: application/json: schema: type: array - items: &99 + items: &101 title: Gist Comment description: A comment made to a gist. type: object @@ -14675,7 +14938,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *83 + author_association: *85 required: - url - id @@ -14715,7 +14978,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -14739,7 +15002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *98 + - *100 requestBody: required: true content: @@ -14764,9 +15027,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: &100 + default: &102 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -14823,8 +15086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *98 - - &102 + - *100 + - &104 name: comment_id description: The unique identifier of the comment. in: path @@ -14837,12 +15100,12 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: *100 + default: *102 '304': *37 '404': *6 - '403': *101 + '403': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14863,8 +15126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *98 - - *102 + - *100 + - *104 requestBody: required: true content: @@ -14889,9 +15152,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *101 examples: - default: *100 + default: *102 '404': *6 x-github: githubCloudOnly: false @@ -14908,8 +15171,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *98 - - *102 + - *100 + - *104 responses: '204': description: Response @@ -14932,7 +15195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *98 + - *100 - *17 - *19 responses: @@ -15033,7 +15296,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *98 + - *100 - *17 - *19 responses: @@ -15043,7 +15306,7 @@ paths: application/json: schema: type: array - items: *96 + items: *98 examples: default: value: @@ -15089,7 +15352,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 '304': *37 '403': *29 @@ -15108,13 +15371,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *98 + - *100 responses: '201': description: Response content: application/json: - schema: *94 + schema: *96 examples: default: value: @@ -15191,7 +15454,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *98 + - *100 responses: '204': description: Response if gist is starred @@ -15221,7 +15484,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -15243,7 +15506,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *98 + - *100 responses: '204': description: Response @@ -15271,7 +15534,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *98 + - *100 - name: sha in: path required: true @@ -15282,9 +15545,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *98 examples: - default: *97 + default: *99 '422': *15 '404': *6 '403': *29 @@ -15445,7 +15708,7 @@ paths: type: array items: allOf: - - *80 + - *82 repository_selection: type: string example: selected @@ -15568,7 +15831,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '403': *29 '304': *37 '401': *25 @@ -15652,7 +15915,7 @@ paths: - closed - all default: open - - &246 + - &248 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15671,7 +15934,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - name: collab in: query required: false @@ -15701,9 +15964,9 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: &247 + default: &249 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15948,7 +16211,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '404': *6 @@ -15987,8 +16250,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 examples: default: value: @@ -16273,7 +16536,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &103 + X-CommonMarker-Version: &105 example: 0.17.4 schema: type: string @@ -16328,7 +16591,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *103 + X-CommonMarker-Version: *105 content: text/html: schema: @@ -16357,7 +16620,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &106 + - &108 name: account_id description: account_id parameter in: path @@ -16369,7 +16632,7 @@ paths: description: Response content: application/json: - schema: &105 + schema: &107 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -16399,7 +16662,7 @@ paths: nullable: true id: type: integer - plan: &104 + plan: &106 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -16488,7 +16751,7 @@ paths: nullable: true updated_at: type: string - plan: *104 + plan: *106 required: - url - id @@ -16496,7 +16759,7 @@ paths: - login - marketplace_purchase examples: - default: &107 + default: &109 value: url: https://api.github.com/orgs/github type: Organization @@ -16581,9 +16844,9 @@ paths: application/json: schema: type: array - items: *104 + items: *106 examples: - default: &108 + default: &110 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -16601,7 +16864,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '404': *6 '401': *25 x-github: @@ -16623,14 +16886,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &109 + - &111 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &110 + - &112 name: sort description: The property to sort the results by. in: query @@ -16660,9 +16923,9 @@ paths: application/json: schema: type: array - items: *105 + items: *107 examples: - default: &111 + default: &113 value: - url: https://api.github.com/orgs/github type: Organization @@ -16713,7 +16976,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '404': *6 '422': *15 '401': *25 @@ -16736,15 +16999,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *106 + - *108 responses: '200': description: Response content: application/json: - schema: *105 + schema: *107 examples: - default: *107 + default: *109 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -16776,11 +17039,11 @@ paths: application/json: schema: type: array - items: *104 + items: *106 examples: - default: *108 + default: *110 headers: - Link: *68 + Link: *70 '401': *25 x-github: githubCloudOnly: false @@ -16801,8 +17064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *109 - - *110 + - *111 + - *112 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -16822,11 +17085,11 @@ paths: application/json: schema: type: array - items: *105 + items: *107 examples: - default: *111 + default: *113 headers: - Link: *68 + Link: *70 '401': *25 x-github: githubCloudOnly: false @@ -17088,14 +17351,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &344 + - &346 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &345 + - &347 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -17112,7 +17375,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -17157,7 +17420,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &348 + '301': &350 description: Moved permanently content: application/json: @@ -17179,7 +17442,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &586 + - &588 name: all description: If `true`, show notifications marked as read. in: query @@ -17187,7 +17450,7 @@ paths: schema: type: boolean default: false - - &587 + - &589 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17196,8 +17459,8 @@ paths: schema: type: boolean default: false - - *93 - - &588 + - *95 + - &590 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -17222,18 +17485,18 @@ paths: application/json: schema: type: array - items: &113 + items: &115 title: Thread description: Thread type: object properties: id: type: string - repository: &159 + repository: &161 title: Minimal Repository description: Minimal Repository type: object - properties: &211 + properties: &213 id: type: integer format: int64 @@ -17519,7 +17782,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &299 + security_and_analysis: &301 nullable: true type: object properties: @@ -17639,7 +17902,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &212 + required: &214 - archive_url - assignees_url - blobs_url @@ -17686,7 +17949,7 @@ paths: - teams_url - trees_url - url - x-github-breaking-changes: &213 + x-github-breaking-changes: &215 - changeset: remove_has_downloads patch: properties: @@ -17733,7 +17996,7 @@ paths: - url - subscription_url examples: - default: &589 + default: &591 value: - id: '1' repository: @@ -17815,7 +18078,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -17899,7 +18162,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &114 + - &116 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -17913,7 +18176,7 @@ paths: description: Response content: application/json: - schema: *113 + schema: *115 examples: default: value: @@ -18015,7 +18278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *114 + - *116 responses: '205': description: Reset Content @@ -18037,7 +18300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *114 + - *116 responses: '204': description: No content @@ -18060,13 +18323,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *114 + - *116 responses: '200': description: Response content: application/json: - schema: &115 + schema: &117 title: Thread Subscription description: Thread Subscription type: object @@ -18103,7 +18366,7 @@ paths: - url - subscribed examples: - default: &116 + default: &118 value: subscribed: true ignored: false @@ -18134,7 +18397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *114 + - *116 requestBody: required: false content: @@ -18155,9 +18418,9 @@ paths: description: Response content: application/json: - schema: *115 + schema: *117 examples: - default: *116 + default: *118 '304': *37 '403': *29 '401': *25 @@ -18180,7 +18443,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *114 + - *116 responses: '204': description: Response @@ -18275,9 +18538,9 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: Link: example: ; rel="next" @@ -18304,13 +18567,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &118 + schema: &120 title: Actions cache retention limit for an organization description: GitHub Actions cache retention policy for an organization. type: object @@ -18343,12 +18606,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *118 + schema: *120 examples: selected_actions: *42 responses: @@ -18377,13 +18640,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &119 + schema: &121 title: Actions cache storage limit for an organization description: GitHub Actions cache storage policy for an organization. type: object @@ -18416,12 +18679,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *119 + schema: *121 examples: selected_actions: *44 responses: @@ -18451,7 +18714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - - *76 + - *78 - name: page description: The page number of the results to fetch. in: query @@ -18623,8 +18886,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization parameters: - - *76 - - &121 + - *78 + - &123 name: budget_id description: The ID corresponding to the budget. in: path @@ -18721,7 +18984,7 @@ paths: '404': *6 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18741,8 +19004,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization parameters: - - *76 - - *121 + - *78 + - *123 requestBody: required: true content: @@ -18933,8 +19196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization parameters: - - *76 - - *121 + - *78 + - *123 responses: '200': description: Response when deleting a budget @@ -18961,7 +19224,7 @@ paths: '404': *6 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18981,8 +19244,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization parameters: - - *76 - - &122 + - *78 + - &124 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -18991,7 +19254,7 @@ paths: required: false schema: type: integer - - &124 + - &126 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current @@ -19000,7 +19263,7 @@ paths: required: false schema: type: integer - - &123 + - &125 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -19015,14 +19278,14 @@ paths: required: false schema: type: string - - &736 + - &738 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &125 + - &127 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -19139,7 +19402,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19159,9 +19422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - - *76 - - *122 - - &737 + - *78 + - *124 + - &739 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -19170,7 +19433,7 @@ paths: required: false schema: type: integer - - *123 + - *125 responses: '200': description: Billing usage report response for an organization @@ -19246,7 +19509,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19269,19 +19532,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization parameters: - - *76 - - *122 + - *78 - *124 - - *123 - - &738 + - *126 + - *125 + - &740 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *125 - - &739 + - *127 + - &741 name: sku description: The SKU to query for usage. in: query @@ -19392,7 +19655,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19418,13 +19681,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &126 + schema: &128 title: Organization Full description: Organization Full type: object @@ -19749,7 +20012,7 @@ paths: path: "/properties/secret_scanning_push_protection_custom_link_enabled" version: '2026-03-10' examples: - default-response: &127 + default-response: &129 value: login: github id: 1 @@ -19855,7 +20118,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *76 + - *78 requestBody: required: false content: @@ -20071,17 +20334,17 @@ paths: description: Response content: application/json: - schema: *126 + schema: *128 examples: - default: *127 + default: *129 '422': description: Validation failed content: application/json: schema: oneOf: - - *128 - - *129 + - *130 + - *131 '409': *54 x-github: githubCloudOnly: false @@ -20115,7 +20378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *76 + - *78 responses: '202': *39 '404': *6 @@ -20146,7 +20409,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20172,7 +20435,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20193,7 +20456,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -20211,7 +20474,7 @@ paths: type: integer repository_cache_usages: type: array - items: &355 + items: &357 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20246,7 +20509,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20266,7 +20529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -20284,7 +20547,7 @@ paths: type: integer runners: type: array - items: &130 + items: &132 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -20338,7 +20601,7 @@ paths: - display_name - source nullable: true - machine_size_details: &138 + machine_size_details: &140 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -20434,7 +20697,7 @@ paths: - public_ip_enabled - platform examples: - default: &158 + default: &160 value: total_count: 2 runners: @@ -20476,7 +20739,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20494,7 +20757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -20571,9 +20834,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: &139 + default: &141 value: id: 5 name: My hosted ubuntu runner @@ -20614,7 +20877,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20630,7 +20893,7 @@ paths: type: integer images: type: array - items: &131 + items: &133 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -20681,7 +20944,7 @@ paths: - latest_version - state examples: - default: &133 + default: &135 value: total_count: 2 image_versions: @@ -20712,8 +20975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - - *76 - - &132 + - *78 + - &134 name: image_definition_id description: Image definition ID of custom image in: path @@ -20725,7 +20988,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *133 examples: default: value: @@ -20755,8 +21018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *76 - - *132 + - *78 + - *134 responses: '204': description: Response @@ -20779,8 +21042,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - - *132 - - *76 + - *134 + - *78 responses: '200': description: Response @@ -20796,7 +21059,7 @@ paths: type: integer image_versions: type: array - items: &134 + items: &136 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -20829,7 +21092,7 @@ paths: - created_on - state_details examples: - default: *133 + default: *135 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20849,9 +21112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - - *76 - - *132 - - &135 + - *78 + - *134 + - &137 name: version description: Version of a custom image in: path @@ -20864,7 +21127,7 @@ paths: description: Response content: application/json: - schema: *134 + schema: *136 examples: default: value: @@ -20890,9 +21153,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - - *76 - - *132 - - *135 + - *78 + - *134 + - *137 responses: '204': description: Response @@ -20913,7 +21176,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -20929,7 +21192,7 @@ paths: type: integer images: type: array - items: &136 + items: &138 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -20965,7 +21228,7 @@ paths: - display_name - source examples: - default: &137 + default: &139 value: id: ubuntu-20.04 platform: linux-x64 @@ -20989,7 +21252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -21005,9 +21268,9 @@ paths: type: integer images: type: array - items: *136 + items: *138 examples: - default: *137 + default: *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21024,7 +21287,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -21077,7 +21340,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -21093,7 +21356,7 @@ paths: type: integer machine_specs: type: array - items: *138 + items: *140 examples: default: value: @@ -21118,7 +21381,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -21162,8 +21425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *76 - - &140 + - *78 + - &142 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -21175,11 +21438,11 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21197,8 +21460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *76 - - *140 + - *78 + - *142 requestBody: required: true content: @@ -21264,9 +21527,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21282,16 +21545,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *76 - - *140 + - *78 + - *142 responses: '202': description: Response content: application/json: - schema: *130 + schema: *132 examples: - default: *139 + default: *141 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21311,7 +21574,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: A JSON array of OIDC custom property inclusions @@ -21344,12 +21607,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: *141 + schema: *143 examples: default: *46 responses: @@ -21383,7 +21646,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization parameters: - - *76 + - *78 - name: custom_property_name in: path required: true @@ -21416,7 +21679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *76 + - *78 responses: '200': description: A JSON serialized template for OIDC subject claim customization @@ -21433,10 +21696,16 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the + name-based format. + type: boolean required: - include_claim_keys examples: - default: &142 + default: &144 value: include_claim_keys: - repo @@ -21458,7 +21727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -21474,14 +21743,20 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: - default: *142 + default: *144 responses: '201': description: Empty response content: application/json: - schema: &168 + schema: &170 title: Empty Object description: An object without any properties. type: object @@ -21511,7 +21786,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -21520,7 +21795,7 @@ paths: schema: type: object properties: - enabled_repositories: &143 + enabled_repositories: &145 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21533,7 +21808,7 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: &144 + allowed_actions: &146 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -21541,12 +21816,12 @@ paths: - all - local_only - selected - selected_actions_url: &361 + selected_actions_url: &363 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &145 + sha_pinning_required: &147 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -21577,7 +21852,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21588,9 +21863,9 @@ paths: schema: type: object properties: - enabled_repositories: *143 - allowed_actions: *144 - sha_pinning_required: *145 + enabled_repositories: *145 + allowed_actions: *146 + sha_pinning_required: *147 required: - enabled_repositories examples: @@ -21618,13 +21893,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &365 + schema: &367 type: object properties: days: @@ -21661,12 +21936,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &366 + schema: &368 type: object properties: days: @@ -21703,13 +21978,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &146 + schema: &148 type: object properties: approval_policy: @@ -21723,7 +21998,7 @@ paths: required: - approval_policy examples: - default: &367 + default: &369 value: approval_policy: first_time_contributors '404': *6 @@ -21744,7 +22019,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -21754,7 +22029,7 @@ paths: required: true content: application/json: - schema: *146 + schema: *148 examples: default: summary: Set approval policy to first time contributors @@ -21776,13 +22051,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &368 + schema: &370 type: object required: - run_workflows_from_fork_pull_requests @@ -21808,7 +22083,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &147 + default: &149 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -21831,12 +22106,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &369 + schema: &371 type: object required: - run_workflows_from_fork_pull_requests @@ -21859,7 +22134,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *147 + default: *149 responses: '204': description: Empty response for successful settings update @@ -21889,7 +22164,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -21907,9 +22182,9 @@ paths: type: number repositories: type: array - items: *80 + items: *82 examples: - default: &151 + default: &153 value: total_count: 1 repositories: @@ -22049,7 +22324,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -22093,8 +22368,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *76 - - &148 + - *78 + - &150 name: repository_id description: The unique identifier of the repository. in: path @@ -22122,8 +22397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -22146,13 +22421,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &149 + schema: &151 type: object properties: github_owned_allowed: @@ -22174,7 +22449,7 @@ paths: items: type: string examples: - default: &150 + default: &152 value: github_owned_allowed: true verified_allowed: false @@ -22199,7 +22474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -22207,9 +22482,9 @@ paths: required: false content: application/json: - schema: *149 + schema: *151 examples: - selected_actions: *150 + selected_actions: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22229,7 +22504,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -22277,7 +22552,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -22324,7 +22599,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -22339,9 +22614,9 @@ paths: type: integer repositories: type: array - items: *80 + items: *82 examples: - default: *151 + default: *153 '403': *29 '404': *6 x-github: @@ -22361,7 +22636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -22409,8 +22684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No content @@ -22436,8 +22711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No content @@ -22465,23 +22740,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &370 + schema: &372 type: object properties: - default_workflow_permissions: &152 + default_workflow_permissions: &154 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &153 + can_approve_pull_request_reviews: &155 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -22489,7 +22764,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &154 + default: &156 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -22514,7 +22789,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Success response @@ -22522,13 +22797,13 @@ paths: required: false content: application/json: - schema: &371 + schema: &373 type: object properties: - default_workflow_permissions: *152 - can_approve_pull_request_reviews: *153 + default_workflow_permissions: *154 + can_approve_pull_request_reviews: *155 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22548,7 +22823,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *76 + - *78 - *17 - *19 - name: visible_to_repository @@ -22573,7 +22848,7 @@ paths: type: number runner_groups: type: array - items: &155 + items: &157 type: object properties: id: @@ -22689,7 +22964,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -22761,9 +23036,9 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: - default: &157 + default: &159 value: id: 2 name: octo-runner-group @@ -22798,8 +23073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *76 - - &156 + - *78 + - &158 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -22811,7 +23086,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: default: value: @@ -22847,8 +23122,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -22902,9 +23177,9 @@ paths: description: Response content: application/json: - schema: *155 + schema: *157 examples: - default: *157 + default: *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22923,8 +23198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *76 - - *156 + - *78 + - *158 responses: '204': description: Response @@ -22947,8 +23222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *17 - *19 responses: @@ -22966,11 +23241,11 @@ paths: type: number runners: type: array - items: *130 + items: *132 examples: - default: *158 + default: *160 headers: - Link: *68 + Link: *70 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22990,8 +23265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *19 - *17 responses: @@ -23009,9 +23284,9 @@ paths: type: number repositories: type: array - items: *159 + items: *161 examples: - default: &196 + default: &198 value: total_count: 1 repositories: @@ -23263,8 +23538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -23308,9 +23583,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 - - *148 + - *78 + - *158 + - *150 responses: '204': description: Response @@ -23332,9 +23607,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *76 - - *156 - - *148 + - *78 + - *158 + - *150 responses: '204': description: Response @@ -23357,8 +23632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 - *17 - *19 responses: @@ -23376,7 +23651,7 @@ paths: type: number runners: type: array - items: &161 + items: &163 title: Self hosted runners description: A self hosted runner type: object @@ -23405,7 +23680,7 @@ paths: type: boolean labels: type: array - items: &164 + items: &166 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -23435,7 +23710,7 @@ paths: - busy - labels examples: - default: &162 + default: &164 value: total_count: 2 runners: @@ -23475,7 +23750,7 @@ paths: name: no-gpu type: custom headers: - Link: *68 + Link: *70 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -23494,8 +23769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *76 - - *156 + - *78 + - *158 requestBody: required: true content: @@ -23539,9 +23814,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *76 - - *156 - - &160 + - *78 + - *158 + - &162 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -23569,9 +23844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *76 - - *156 - - *160 + - *78 + - *158 + - *162 responses: '204': description: Response @@ -23601,7 +23876,7 @@ paths: in: query schema: type: string - - *76 + - *78 - *17 - *19 responses: @@ -23619,11 +23894,11 @@ paths: type: integer runners: type: array - items: *161 + items: *163 examples: - default: *162 + default: *164 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23645,7 +23920,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -23653,7 +23928,7 @@ paths: application/json: schema: type: array - items: &372 + items: &374 title: Runner Application description: Runner Application type: object @@ -23678,7 +23953,7 @@ paths: - download_url - filename examples: - default: &373 + default: &375 value: - os: osx architecture: x64 @@ -23721,7 +23996,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -23764,7 +24039,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &374 + '201': &376 description: Response content: application/json: @@ -23774,7 +24049,7 @@ paths: - runner - encoded_jit_config properties: - runner: *161 + runner: *163 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -23831,13 +24106,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *76 + - *78 responses: '201': description: Response content: application/json: - schema: &163 + schema: &165 title: Authentication Token description: Authentication Token type: object @@ -23859,7 +24134,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *80 + items: *82 single_file: type: string example: config.yaml @@ -23875,7 +24150,7 @@ paths: - token - expires_at examples: - default: &375 + default: &377 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23906,15 +24181,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *76 + - *78 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: &376 + default: &378 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23939,16 +24214,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: '200': description: Response content: application/json: - schema: *161 + schema: *163 examples: - default: &377 + default: &379 value: id: 23 name: MBP @@ -23989,8 +24264,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: '204': description: Response @@ -24016,10 +24291,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: - '200': &165 + '200': &167 description: Response content: application/json: @@ -24033,7 +24308,7 @@ paths: type: integer labels: type: array - items: *164 + items: *166 examples: default: value: @@ -24072,8 +24347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 requestBody: required: true content: @@ -24097,7 +24372,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -24121,8 +24396,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 requestBody: required: true content: @@ -24147,7 +24422,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -24171,10 +24446,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 + - *78 + - *162 responses: - '200': &378 + '200': &380 description: Response content: application/json: @@ -24188,7 +24463,7 @@ paths: type: integer labels: type: array - items: *164 + items: *166 examples: default: value: @@ -24229,9 +24504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *76 - - *160 - - &379 + - *78 + - *162 + - &381 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24239,7 +24514,7 @@ paths: schema: type: string responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -24264,7 +24539,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -24282,7 +24557,7 @@ paths: type: integer secrets: type: array - items: &166 + items: &168 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -24332,7 +24607,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24355,13 +24630,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &391 + schema: &393 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24390,7 +24665,7 @@ paths: - key_id - key examples: - default: &392 + default: &394 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24415,8 +24690,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *76 - - &167 + - *78 + - &169 name: secret_name description: The name of the secret. in: path @@ -24428,7 +24703,7 @@ paths: description: Response content: application/json: - schema: *166 + schema: *168 examples: default: value: @@ -24458,8 +24733,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -24516,7 +24791,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -24542,8 +24817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -24569,8 +24844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -24588,9 +24863,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: &171 + default: &173 value: total_count: 1 repositories: @@ -24682,8 +24957,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -24735,8 +25010,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -24769,8 +25044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -24802,8 +25077,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *76 - - &360 + - *78 + - &362 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -24827,7 +25102,7 @@ paths: type: integer variables: type: array - items: &169 + items: &171 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -24891,7 +25166,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24912,7 +25187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *76 + - *78 requestBody: required: true content: @@ -24960,7 +25235,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -24985,8 +25260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *76 - - &170 + - *78 + - &172 name: name description: The name of the variable. in: path @@ -24998,7 +25273,7 @@ paths: description: Response content: application/json: - schema: *169 + schema: *171 examples: default: value: @@ -25028,8 +25303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 requestBody: required: true content: @@ -25091,8 +25366,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 responses: '204': description: Response @@ -25118,8 +25393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - *19 - *17 responses: @@ -25137,9 +25412,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 '409': description: Response when the visibility of the variable is not set to `selected` @@ -25165,8 +25440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 requestBody: required: true content: @@ -25215,8 +25490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - name: repository_id in: path required: true @@ -25250,8 +25525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *76 - - *170 + - *78 + - *172 - name: repository_id in: path required: true @@ -25292,7 +25567,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *76 + - *78 requestBody: required: true content: @@ -25415,7 +25690,7 @@ paths: type: integer deployment_records: type: array - items: &172 + items: &174 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -25461,7 +25736,7 @@ paths: required: - total_count examples: - default: &173 + default: &175 value: total_count: 1 deployment_records: @@ -25498,7 +25773,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *76 + - *78 - name: cluster in: path description: The cluster name. @@ -25641,11 +25916,11 @@ paths: type: integer deployment_records: type: array - items: *172 + items: *174 required: - total_count examples: - default: *173 + default: *175 '403': description: Forbidden content: @@ -25692,7 +25967,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *76 + - *78 requestBody: required: true content: @@ -25855,7 +26130,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *76 + - *78 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -25880,9 +26155,9 @@ paths: type: integer deployment_records: type: array - items: *172 + items: *174 examples: - default: *173 + default: *175 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25902,7 +26177,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *76 + - *78 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -25987,7 +26262,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 requestBody: required: true content: @@ -26011,12 +26286,12 @@ paths: required: - subject_digests examples: - default: &718 + default: &720 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &719 + withPredicateType: &721 value: subject_digests: - sha256:abc123 @@ -26074,7 +26349,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &720 + default: &722 value: attestations_subject_digests: - sha256:abc: @@ -26198,7 +26473,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *76 + - *78 requestBody: required: true content: @@ -26263,7 +26538,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *76 + - *78 - name: subject_digest description: Subject Digest in: path @@ -26298,7 +26573,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -26346,7 +26621,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *76 + - *78 - name: attestation_id description: Attestation ID in: path @@ -26384,7 +26659,7 @@ paths: - *17 - *47 - *48 - - *76 + - *78 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -26439,7 +26714,7 @@ paths: initiator: type: string examples: - default: &405 + default: &407 value: attestations: - bundle: @@ -26560,7 +26835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -26572,7 +26847,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26591,8 +26866,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: If the user is blocked @@ -26617,8 +26892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -26638,8 +26913,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -26664,7 +26939,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *76 + - *78 - *19 - *17 - *62 @@ -26672,7 +26947,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &174 + schema: &176 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -26698,7 +26973,7 @@ paths: application/json: schema: type: array - items: &175 + items: &177 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -26729,7 +27004,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &195 + items: &197 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -26804,7 +27079,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &258 + properties: &260 id: description: Unique identifier of the team type: integer @@ -26876,7 +27151,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &259 + required: &261 - id - node_id - url @@ -26919,7 +27194,7 @@ paths: type: string format: date-time nullable: true - state: *174 + state: *176 contact_link: description: The contact link of the campaign. type: string @@ -27014,9 +27289,9 @@ paths: closed_at: state: open headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27040,7 +27315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -27139,9 +27414,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: &176 + default: &178 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -27190,7 +27465,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27212,7 +27487,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -27224,16 +27499,16 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: *176 + default: *178 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27254,7 +27529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -27303,7 +27578,7 @@ paths: type: string format: uri nullable: true - state: *174 + state: *176 examples: default: value: @@ -27313,9 +27588,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *177 examples: - default: *176 + default: *178 '400': description: Bad Request content: @@ -27327,7 +27602,7 @@ paths: content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27348,7 +27623,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *76 + - *78 - name: campaign_number description: The campaign number. in: path @@ -27359,7 +27634,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27381,18 +27656,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *76 - - &430 + - *78 + - &432 name: tool_name 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. in: query required: false - schema: &184 + schema: &186 type: string description: The name of the tool used to generate the code scanning analysis. - - &431 + - &433 name: tool_guid 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 @@ -27400,7 +27675,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &185 + schema: &187 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -27415,7 +27690,7 @@ paths: be returned. in: query required: false - schema: &433 + schema: &435 type: string description: State of a code scanning alert. enum: @@ -27438,7 +27713,7 @@ paths: be returned. in: query required: false - schema: &434 + schema: &436 type: string description: Severity of a code scanning alert. enum: @@ -27467,18 +27742,18 @@ paths: items: type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: &435 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: &437 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &186 + state: &188 type: string description: State of a code scanning alert. nullable: true @@ -27486,7 +27761,7 @@ paths: - open - dismissed - fixed - fixed_at: *182 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -27494,8 +27769,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: &436 + dismissed_at: *185 + dismissed_reason: &438 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -27504,13 +27779,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &437 + dismissed_comment: &439 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &438 + rule: &440 type: object properties: id: @@ -27563,42 +27838,42 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &439 + tool: &441 type: object properties: - name: *184 + name: *186 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *185 - most_recent_instance: &440 + guid: *187 + most_recent_instance: &442 type: object properties: - ref: &432 + ref: &434 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &450 + analysis_key: &452 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &451 + environment: &453 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &452 + category: &454 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *186 + state: *188 commit_sha: type: string message: @@ -27612,7 +27887,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &453 + location: &455 type: object description: Describe a region within a file for the alert. properties: @@ -27633,7 +27908,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &454 + items: &456 type: string description: A classification of the file. For example to identify it as generated. @@ -27898,9 +28173,9 @@ paths: trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27922,7 +28197,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *76 + - *78 - name: target_type in: query description: The target type of the code security configuration @@ -28028,7 +28303,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *76 + - *78 requestBody: required: true content: @@ -28272,7 +28547,7 @@ paths: application/json: schema: *49 examples: - default: *187 + default: *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28294,15 +28569,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *188 + schema: *190 examples: - default: *189 + default: *191 '304': *37 '403': *29 '404': *6 @@ -28328,7 +28603,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *76 + - *78 requestBody: required: true content: @@ -28336,6 +28611,8 @@ paths: schema: type: object additionalProperties: false + required: + - selected_repository_ids properties: selected_repository_ids: type: array @@ -28380,7 +28657,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *76 + - *78 - *51 responses: '200': @@ -28389,7 +28666,7 @@ paths: application/json: schema: *49 examples: - default: *187 + default: *189 '304': *37 '403': *29 '404': *6 @@ -28413,7 +28690,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28693,7 +28970,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *76 + - *78 - *51 responses: '204': *61 @@ -28724,7 +29001,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28788,7 +29065,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *76 + - *78 - *51 requestBody: required: true @@ -28834,7 +29111,7 @@ paths: default: value: default_for_new_repos: all - configuration: *187 + configuration: *189 '403': *29 '404': *6 x-github: @@ -28858,7 +29135,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *76 + - *78 - *51 - name: per_page description: The number of results per page (max 100). For more information, @@ -28887,13 +29164,13 @@ paths: application/json: schema: type: array - items: *190 + items: *192 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *191 + repository: *193 '403': *29 '404': *6 x-github: @@ -28917,7 +29194,7 @@ paths: parameters: - *17 - *19 - - *76 + - *78 responses: '200': description: Response @@ -28933,7 +29210,7 @@ paths: type: integer codespaces: type: array - items: &248 + items: &250 type: object title: Codespace description: A codespace. @@ -28958,12 +29235,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *159 + repository: *161 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &466 + properties: &468 name: type: string description: The name of the machine. @@ -29005,7 +29282,7 @@ paths: - ready - in_progress nullable: true - required: &467 + required: &469 - name - display_name - operating_system @@ -29210,7 +29487,7 @@ paths: - pulls_url - recent_folders examples: - default: &249 + default: &251 value: total_count: 3 codespaces: @@ -29642,7 +29919,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *76 + - *78 deprecated: true requestBody: required: true @@ -29709,7 +29986,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *76 + - *78 deprecated: true requestBody: required: true @@ -29764,7 +30041,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *76 + - *78 requestBody: required: true content: @@ -29816,7 +30093,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -29834,7 +30111,7 @@ paths: type: integer secrets: type: array - items: &192 + items: &194 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -29873,7 +30150,7 @@ paths: - updated_at - visibility examples: - default: &468 + default: &470 value: total_count: 2 secrets: @@ -29886,7 +30163,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -29905,13 +30182,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &469 + schema: &471 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -29940,7 +30217,7 @@ paths: - key_id - key examples: - default: &470 + default: &472 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29963,23 +30240,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: Response content: application/json: - schema: *192 + schema: *194 examples: - default: &472 + default: &474 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -29999,8 +30276,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -30055,7 +30332,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -30081,8 +30358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -30107,8 +30384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -30126,9 +30403,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 '404': *6 x-github: githubCloudOnly: false @@ -30150,8 +30427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -30201,8 +30478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -30235,8 +30512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -30275,7 +30552,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: OK @@ -30416,7 +30693,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *76 + - *78 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -30439,7 +30716,7 @@ paths: currently being billed. seats: type: array - items: &251 + items: &253 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -30456,15 +30733,15 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *193 - required: *194 + properties: *195 + required: *196 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *195 - - *69 + - *197 + - *71 nullable: true pending_cancellation_date: type: string @@ -30588,7 +30865,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '500': *55 '401': *25 '403': *29 @@ -30622,7 +30899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30700,7 +30977,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30780,7 +31057,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30857,7 +31134,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *76 + - *78 requestBody: content: application/json: @@ -30935,7 +31212,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -31000,7 +31277,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -31055,7 +31332,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -31070,12 +31347,12 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 required: - total_count - repositories examples: - default: *196 + default: *198 '500': *55 '401': *25 '403': *29 @@ -31104,7 +31381,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -31160,8 +31437,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No Content @@ -31194,8 +31471,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: No Content @@ -31234,7 +31511,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization parameters: - - *76 + - *78 responses: '200': description: OK @@ -31287,7 +31564,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization parameters: - - *76 + - *78 requestBody: description: The content exclusion rules to set required: true @@ -31378,7 +31655,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *76 + - *78 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -31410,7 +31687,7 @@ paths: application/json: schema: type: array - items: &337 + items: &339 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -31717,7 +31994,7 @@ paths: - date additionalProperties: true examples: - default: &338 + default: &340 value: - date: '2024-06-24' total_active_users: 24 @@ -31819,7 +32096,7 @@ paths: '500': *55 '403': *29 '404': *6 - '422': &339 + '422': &341 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -31850,7 +32127,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day parameters: - - *76 + - *78 - *56 responses: '200': @@ -31889,7 +32166,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics parameters: - - *76 + - *78 responses: '200': description: Response @@ -31926,7 +32203,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day parameters: - - *76 + - *78 - *56 responses: '200': @@ -31965,7 +32242,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics parameters: - - *76 + - *78 responses: '200': description: Response @@ -31998,13 +32275,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *76 - - *197 - - *198 + - *78 - *199 - *200 - *201 - *202 + - *203 + - *204 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -32034,7 +32311,7 @@ paths: enum: - patch - deployment - - *203 + - *205 - name: runtime_risk in: query description: |- @@ -32043,8 +32320,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *204 - - *205 + - *206 + - *207 - *62 - *47 - *48 @@ -32056,9 +32333,9 @@ paths: application/json: schema: type: array - items: *206 + items: *208 examples: - default: *207 + default: *209 '304': *37 '400': *14 '403': *29 @@ -32084,7 +32361,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *76 + - *78 - name: page in: query description: The page number of results to fetch. @@ -32107,104 +32384,9 @@ paths: description: Response content: application/json: - schema: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able - to access in an organization - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot - updates. - enum: - - public - - internal - example: internal - nullable: true - accessible_repositories: - type: array - items: - title: Simple Repository - description: A GitHub repository. - type: object - properties: *208 - required: *209 - nullable: true - additionalProperties: false + schema: *210 examples: - default: - value: - default_level: public - accessible_repositories: - - id: 123456 - node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= - name: example-repo - full_name: octocat/example-repo - owner: - name: octocat - email: octo@github.com - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://avatars.githubusercontent.com/u/1?v=4 - gravatar_id: 1 - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat/example-repo - 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 - starred_at: '"2020-07-09T00:17:55Z"' - user_view_type: default - private: false - html_url: https://github.com/octocat/example-repo - description: This is an example repository. - fork: false - url: https://api.github.com/repos/octocat/example-repo - archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} - commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} - compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/example-repo/contributors - deployments_url: https://api.github.com/repos/octocat/example-repo/deployments - downloads_url: https://api.github.com/repos/octocat/example-repo/downloads - events_url: https://api.github.com/repos/octocat/example-repo/events - forks_url: https://api.github.com/repos/octocat/example-repo/forks - git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} - keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} - languages_url: https://api.github.com/repos/octocat/example-repo/languages - merges_url: https://api.github.com/repos/octocat/example-repo/merges - milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} - releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers - statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/example-repo/subscription - tags_url: https://api.github.com/repos/octocat/example-repo/tags - teams_url: https://api.github.com/repos/octocat/example-repo/teams - trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + default: *211 '403': *29 '404': *6 x-github: @@ -32235,7 +32417,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -32301,7 +32483,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *76 + - *78 requestBody: required: true content: @@ -32349,7 +32531,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32367,7 +32549,7 @@ paths: type: integer secrets: type: array - items: &210 + items: &212 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -32417,7 +32599,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32438,13 +32620,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: &503 + schema: &505 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -32461,7 +32643,7 @@ paths: - key_id - key examples: - default: &504 + default: &506 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -32484,14 +32666,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: Response content: application/json: - schema: *210 + schema: *212 examples: default: value: @@ -32519,8 +32701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -32577,7 +32759,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -32609,8 +32791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -32634,8 +32816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - *19 - *17 responses: @@ -32653,9 +32835,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32676,8 +32858,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -32727,8 +32909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -32759,8 +32941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *76 - - *167 + - *78 + - *169 - name: repository_id in: path required: true @@ -32790,7 +32972,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -32798,7 +32980,7 @@ paths: application/json: schema: type: array - items: &261 + items: &263 title: Package description: A software package type: object @@ -32848,9 +33030,9 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *211 - required: *212 - x-github-breaking-changes: *213 + properties: *213 + required: *214 + x-github-breaking-changes: *215 nullable: true created_at: type: string @@ -32869,7 +33051,7 @@ paths: - created_at - updated_at examples: - default: &262 + default: &264 value: - id: 197 name: hello_docker @@ -32947,7 +33129,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *76 + - *78 - *17 - *19 responses: @@ -32957,7 +33139,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: 200-response: value: @@ -33029,7 +33211,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *76 + - *78 - *17 - *19 responses: @@ -33039,7 +33221,7 @@ paths: application/json: schema: type: array - items: &237 + items: &239 title: Organization Invitation description: Organization Invitation type: object @@ -33086,7 +33268,7 @@ paths: - invitation_teams_url - node_id examples: - default: &238 + default: &240 value: - id: 1 login: monalisa @@ -33119,7 +33301,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -33143,7 +33325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *76 + - *78 - *17 - *19 responses: @@ -33153,7 +33335,7 @@ paths: application/json: schema: type: array - items: &214 + items: &216 title: Org Hook description: Org Hook type: object @@ -33241,7 +33423,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -33264,7 +33446,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *76 + - *78 requestBody: required: true content: @@ -33324,9 +33506,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *216 examples: - default: &215 + default: &217 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -33373,8 +33555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *76 - - &216 + - *78 + - &218 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -33387,9 +33569,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *216 examples: - default: *215 + default: *217 '404': *6 x-github: githubCloudOnly: false @@ -33416,8 +33598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *76 - - *216 + - *78 + - *218 requestBody: required: false content: @@ -33462,7 +33644,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *216 examples: default: value: @@ -33503,8 +33685,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *76 - - *216 + - *78 + - *218 responses: '204': description: Response @@ -33531,8 +33713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *76 - - *216 + - *78 + - *218 responses: '200': description: Response @@ -33562,8 +33744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *76 - - *216 + - *78 + - *218 requestBody: required: false content: @@ -33613,11 +33795,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *76 - - *216 - - *17 - - *217 + - *78 - *218 + - *17 + - *219 + - *220 responses: '200': description: Response @@ -33625,9 +33807,9 @@ paths: application/json: schema: type: array - items: *219 + items: *221 examples: - default: *220 + default: *222 '400': *14 '422': *15 x-github: @@ -33652,17 +33834,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *76 - - *216 + - *78 + - *218 - *16 responses: '200': description: Response content: application/json: - schema: *221 + schema: *223 examples: - default: *222 + default: *224 '400': *14 '422': *15 x-github: @@ -33687,8 +33869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *76 - - *216 + - *78 + - *218 - *16 responses: '202': *39 @@ -33717,8 +33899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *76 - - *216 + - *78 + - *218 responses: '204': description: Response @@ -33740,8 +33922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *76 - - &227 + - *78 + - &229 name: actor_type in: path description: The type of the actor @@ -33754,14 +33936,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &228 + - &230 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &223 + - &225 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -33769,7 +33951,7 @@ paths: required: true schema: type: string - - &224 + - &226 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -33862,13 +34044,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *76 - - *223 - - *224 + - *78 + - *225 + - *226 - *19 - *17 - *62 - - &233 + - &235 name: sort description: The property to sort the results by. in: query @@ -33945,15 +34127,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *76 - - *223 - - *224 + - *78 + - *225 + - *226 responses: '200': description: Response content: application/json: - schema: &225 + schema: &227 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -33969,7 +34151,7 @@ paths: type: integer format: int64 examples: - default: &226 + default: &228 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -33989,24 +34171,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *76 - - &229 + - *78 + - &231 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *223 - - *224 + - *225 + - *226 responses: '200': description: Response content: application/json: - schema: *225 + schema: *227 examples: - default: *226 + default: *228 x-github: enabledForGitHubApps: true category: orgs @@ -34024,19 +34206,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *76 - - *223 - - *224 - - *227 - - *228 + - *78 + - *225 + - *226 + - *229 + - *230 responses: '200': description: Response content: application/json: - schema: *225 + schema: *227 examples: - default: *226 + default: *228 x-github: enabledForGitHubApps: true category: orgs @@ -34053,10 +34235,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *76 - - *223 - - *224 - - &230 + - *78 + - *225 + - *226 + - &232 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -34069,7 +34251,7 @@ paths: description: Response content: application/json: - schema: &231 + schema: &233 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -34085,7 +34267,7 @@ paths: type: integer format: int64 examples: - default: &232 + default: &234 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -34121,19 +34303,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *76 - - *229 - - *223 - - *224 - - *230 + - *78 + - *231 + - *225 + - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *231 + schema: *233 examples: - default: *232 + default: *234 x-github: enabledForGitHubApps: true category: orgs @@ -34150,20 +34332,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *76 - - *227 - - *228 - - *223 - - *224 + - *78 + - *229 - *230 + - *225 + - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *231 + schema: *233 examples: - default: *232 + default: *234 x-github: enabledForGitHubApps: true category: orgs @@ -34180,14 +34362,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *76 - - *229 - - *223 - - *224 + - *78 + - *231 + - *225 + - *226 - *19 - *17 - *62 - - *233 + - *235 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -34260,7 +34442,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *76 + - *78 responses: '200': description: Response @@ -34268,7 +34450,7 @@ paths: application/json: schema: *22 examples: - default: &543 + default: &545 value: id: 1 account: @@ -34337,7 +34519,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -34407,7 +34589,7 @@ paths: suspended_at: suspended_by: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34426,7 +34608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -34434,12 +34616,12 @@ paths: application/json: schema: anyOf: - - &235 + - &237 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &234 + limit: &236 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -34464,7 +34646,7 @@ paths: properties: {} additionalProperties: false examples: - default: &236 + default: &238 value: limit: collaborators_only origin: organization @@ -34488,18 +34670,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: application/json: - schema: &544 + schema: &546 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *234 + limit: *236 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -34523,9 +34705,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *237 examples: - default: *236 + default: *238 '422': *15 x-github: githubCloudOnly: false @@ -34543,7 +34725,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -34567,7 +34749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *76 + - *78 - *17 - *19 - name: role @@ -34601,11 +34783,11 @@ paths: application/json: schema: type: array - items: *237 + items: *239 examples: - default: *238 + default: *240 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -34626,7 +34808,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *76 + - *78 requestBody: required: false content: @@ -34680,7 +34862,7 @@ paths: description: Response content: application/json: - schema: *237 + schema: *239 examples: default: value: @@ -34734,8 +34916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *76 - - &239 + - *78 + - &241 name: invitation_id description: The unique identifier of the invitation. in: path @@ -34765,8 +34947,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *76 - - *239 + - *78 + - *241 - *17 - *19 responses: @@ -34776,9 +34958,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: &260 + default: &262 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -34794,7 +34976,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -34813,7 +34995,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#list-issue-fields-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -34821,7 +35003,7 @@ paths: application/json: schema: type: array - items: &240 + items: &242 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -34964,7 +35146,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#create-issue-field-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -35054,9 +35236,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *242 examples: - default: &241 + default: &243 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -35111,8 +35293,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - - *76 - - &242 + - *78 + - &244 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -35220,9 +35402,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *242 examples: - default: *241 + default: *243 '404': *6 '422': *7 x-github: @@ -35246,8 +35428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - - *76 - - *242 + - *78 + - *244 responses: '204': *61 '404': *6 @@ -35269,7 +35451,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -35277,7 +35459,7 @@ paths: application/json: schema: type: array - items: *243 + items: *245 examples: default: value: @@ -35315,7 +35497,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -35362,9 +35544,9 @@ paths: description: Response content: application/json: - schema: *243 + schema: *245 examples: - default: &244 + default: &246 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -35396,8 +35578,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *76 - - &245 + - *78 + - &247 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -35450,9 +35632,9 @@ paths: description: Response content: application/json: - schema: *243 + schema: *245 examples: - default: *244 + default: *246 '404': *6 '422': *7 x-github: @@ -35476,8 +35658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *76 - - *245 + - *78 + - *247 responses: '204': description: Response @@ -35510,7 +35692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *76 + - *78 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -35540,7 +35722,7 @@ paths: - closed - all default: open - - *246 + - *248 - name: type description: Can be the name of an issue type. in: query @@ -35559,7 +35741,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -35569,11 +35751,11 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *247 + default: *249 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -35593,7 +35775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *76 + - *78 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -35631,9 +35813,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -35651,8 +35833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response if requester is an organization member and user is @@ -35686,8 +35868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -35719,8 +35901,8 @@ paths: parameters: - *17 - *19 - - *76 - - *72 + - *78 + - *74 responses: '200': description: Response @@ -35736,9 +35918,9 @@ paths: type: integer codespaces: type: array - items: *248 + items: *250 examples: - default: *249 + default: *251 '304': *37 '500': *55 '401': *25 @@ -35763,9 +35945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *76 - - *72 - - &250 + - *78 + - *74 + - &252 name: codespace_name in: path required: true @@ -35798,17 +35980,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *76 - - *72 - - *250 + - *78 + - *74 + - *252 responses: '200': description: Response content: application/json: - schema: *248 + schema: *250 examples: - default: &465 + default: &467 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -35981,14 +36163,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *251 + schema: *253 examples: default: value: @@ -36057,14 +36239,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '200': description: Response content: application/json: - schema: &252 + schema: &254 title: Org Membership description: Org Membership type: object @@ -36108,7 +36290,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *74 + organization: *76 user: title: Simple User description: A GitHub user. @@ -36131,7 +36313,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &253 + response-if-user-has-an-active-admin-membership-with-organization: &255 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -36203,8 +36385,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 requestBody: required: false content: @@ -36232,9 +36414,9 @@ paths: description: Response content: application/json: - schema: *252 + schema: *254 examples: - response-if-user-already-had-membership-with-organization: *253 + response-if-user-already-had-membership-with-organization: *255 '422': *15 '403': *29 x-github: @@ -36264,8 +36446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -36290,7 +36472,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *76 + - *78 - *17 - *19 - name: exclude @@ -36311,7 +36493,7 @@ paths: application/json: schema: type: array - items: &254 + items: &256 title: Migration description: A migration. type: object @@ -36352,7 +36534,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *80 + items: *82 url: type: string format: uri @@ -36559,7 +36741,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36575,7 +36757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *76 + - *78 requestBody: required: true content: @@ -36651,7 +36833,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *256 examples: default: value: @@ -36829,8 +37011,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *76 - - &255 + - *78 + - &257 name: migration_id description: The unique identifier of the migration. in: path @@ -36857,7 +37039,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *254 + schema: *256 examples: default: value: @@ -37026,8 +37208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *76 - - *255 + - *78 + - *257 responses: '302': description: Response @@ -37048,8 +37230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *76 - - *255 + - *78 + - *257 responses: '204': description: Response @@ -37072,9 +37254,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *76 - - *255 - - &701 + - *78 + - *257 + - &703 name: repo_name description: repo_name parameter in: path @@ -37101,8 +37283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *76 - - *255 + - *78 + - *257 - *17 - *19 responses: @@ -37112,9 +37294,9 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: &267 + default: &269 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -37227,7 +37409,7 @@ paths: secret_scanning_delegated_alert_dismissal: status: disabled headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -37271,7 +37453,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response - list of organization roles @@ -37287,7 +37469,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &257 + items: &259 title: Organization Role description: Organization roles type: object @@ -37434,8 +37616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -37460,9 +37642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *76 - *78 - - &256 + - *80 + - &258 name: role_id description: The unique identifier of the role. in: path @@ -37497,9 +37679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *76 - *78 - - *256 + - *80 + - *258 responses: '204': description: Response @@ -37524,8 +37706,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -37550,9 +37732,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *76 - - *72 - - *256 + - *78 + - *74 + - *258 responses: '204': description: Response @@ -37582,9 +37764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *76 - - *72 - - *256 + - *78 + - *74 + - *258 responses: '204': description: Response @@ -37612,14 +37794,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *76 - - *256 + - *78 + - *258 responses: '200': description: Response content: application/json: - schema: *257 + schema: *259 examples: default: value: @@ -37669,8 +37851,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *76 - - *256 + - *78 + - *258 - *17 - *19 responses: @@ -37748,8 +37930,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *258 - required: *259 + properties: *260 + required: *261 nullable: true type: description: The ownership type of the team @@ -37781,9 +37963,9 @@ paths: - type - parent examples: - default: *260 + default: *262 headers: - Link: *68 + Link: *70 '404': description: Response if the organization or role does not exist. '422': @@ -37810,8 +37992,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *76 - - *256 + - *78 + - *258 - *17 - *19 responses: @@ -37839,13 +38021,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &333 + items: &335 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *258 - required: *259 + properties: *260 + required: *261 name: nullable: true type: string @@ -37940,9 +38122,9 @@ paths: - type - url examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': description: Response if the organization or role does not exist. '422': @@ -37964,7 +38146,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *76 + - *78 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -37991,9 +38173,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38016,8 +38198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *76 - - *72 + - *78 + - *74 requestBody: required: false content: @@ -38074,8 +38256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -38132,8 +38314,8 @@ paths: - docker - nuget - container - - *76 - - &702 + - *78 + - &704 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -38169,12 +38351,12 @@ paths: application/json: schema: type: array - items: *261 + items: *263 examples: - default: *262 + default: *264 '403': *29 '401': *25 - '400': &704 + '400': &706 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -38196,7 +38378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &263 + - &265 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -38214,20 +38396,20 @@ paths: - docker - nuget - container - - &264 + - &266 name: package_name description: The name of the package. in: path required: true schema: type: string - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *261 + schema: *263 examples: default: value: @@ -38279,9 +38461,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *263 - - *264 - - *76 + - *265 + - *266 + - *78 responses: '204': description: Response @@ -38313,9 +38495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *263 - - *264 - - *76 + - *265 + - *266 + - *78 - name: token description: package token schema: @@ -38347,9 +38529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *263 - - *264 - - *76 + - *265 + - *266 + - *78 - *19 - *17 - name: state @@ -38369,7 +38551,7 @@ paths: application/json: schema: type: array - items: &265 + items: &267 title: Package Version description: A version of a software package type: object @@ -38494,10 +38676,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *263 - - *264 - - *76 - - &266 + - *265 + - *266 + - *78 + - &268 name: package_version_id description: Unique identifier of the package version. in: path @@ -38509,7 +38691,7 @@ paths: description: Response content: application/json: - schema: *265 + schema: *267 examples: default: value: @@ -38545,10 +38727,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *263 - - *264 - - *76 + - *265 - *266 + - *78 + - *268 responses: '204': description: Response @@ -38580,10 +38762,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *263 - - *264 - - *76 + - *265 - *266 + - *78 + - *268 responses: '204': description: Response @@ -38610,10 +38792,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *76 + - *78 - *17 - *19 - - &268 + - &270 name: sort description: The property by which to sort the results. in: query @@ -38624,7 +38806,7 @@ paths: - created_at default: created_at - *62 - - &269 + - &271 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -38635,7 +38817,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &270 + - &272 name: repository description: The name of the repository to use to filter the results. in: query @@ -38643,7 +38825,7 @@ paths: schema: type: string example: Hello-World - - &271 + - &273 name: permission description: The permission to use to filter the results. in: query @@ -38651,7 +38833,7 @@ paths: schema: type: string example: issues_read - - &272 + - &274 name: last_used_before 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) @@ -38661,7 +38843,7 @@ paths: schema: type: string format: date-time - - &273 + - &275 name: last_used_after 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) @@ -38671,7 +38853,7 @@ paths: schema: type: string format: date-time - - &274 + - &276 name: token_id description: The ID of the token in: query @@ -38815,7 +38997,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38835,7 +39017,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *76 + - *78 requestBody: required: true content: @@ -38901,7 +39083,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *76 + - *78 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -38962,7 +39144,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *76 + - *78 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -38982,11 +39164,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39007,17 +39189,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *76 + - *78 - *17 - *19 - - *268 - - *62 - - *269 - *270 + - *62 - *271 - *272 - *273 - *274 + - *275 + - *276 responses: '500': *55 '422': *15 @@ -39146,7 +39328,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39166,7 +39348,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *76 + - *78 requestBody: required: true content: @@ -39226,7 +39408,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *76 + - *78 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -39278,7 +39460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *76 + - *78 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -39297,11 +39479,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39323,7 +39505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -39341,7 +39523,7 @@ paths: type: integer configurations: type: array - items: &275 + items: &277 title: Organization private registry description: Private registry configuration for an organization type: object @@ -39470,7 +39652,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *68 + Link: *70 '400': *14 '404': *6 x-github: @@ -39493,7 +39675,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -39812,7 +39994,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &276 + org-private-registry-with-selected-visibility: &278 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -39853,7 +40035,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -39879,7 +40061,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -39901,16 +40083,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *275 + schema: *277 examples: - default: *276 + default: *278 '404': *6 x-github: githubCloudOnly: false @@ -39932,8 +40114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 requestBody: required: true content: @@ -40109,8 +40291,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *76 - - *167 + - *78 + - *169 responses: '204': description: Response @@ -40133,7 +40315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *76 + - *78 - name: q description: Limit results to projects of the specified type. in: query @@ -40150,7 +40332,7 @@ paths: application/json: schema: type: array - items: &277 + items: &279 title: Projects v2 Project description: A projects v2 project type: object @@ -40220,7 +40402,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &793 + properties: &795 id: type: number description: The unique identifier of the status update. @@ -40268,7 +40450,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &794 + required: &796 - id - node_id - created_at @@ -40293,7 +40475,7 @@ paths: - deleted_at - deleted_by examples: - default: &278 + default: &280 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -40376,7 +40558,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -40396,24 +40578,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &279 + - &281 name: project_number description: The project's number. in: path required: true schema: type: integer - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *277 + schema: *279 examples: - default: *278 + default: *280 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -40433,8 +40615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *76 - - *279 + - *78 + - *281 requestBody: required: true description: Details of the draft item to create in the project. @@ -40468,7 +40650,7 @@ paths: description: Response content: application/json: - schema: &285 + schema: &287 title: Projects v2 Item description: An item belonging to a project type: object @@ -40481,8 +40663,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *86 - - &482 + - *88 + - &484 title: Pull Request Simple description: Pull Request Simple type: object @@ -40588,8 +40770,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *280 - required: *281 + properties: *282 + required: *283 nullable: true active_lock_reason: type: string @@ -40632,7 +40814,7 @@ paths: items: *4 requested_teams: type: array - items: *195 + items: *197 head: type: object properties: @@ -40640,7 +40822,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: @@ -40663,7 +40845,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: @@ -40682,7 +40864,7 @@ paths: _links: type: object properties: - comments: &282 + comments: &284 title: Link description: Hypermedia Link type: object @@ -40691,13 +40873,13 @@ paths: type: string required: - href - commits: *282 - statuses: *282 - html: *282 - issue: *282 - review_comments: *282 - review_comment: *282 - self: *282 + commits: *284 + statuses: *284 + html: *284 + issue: *284 + review_comments: *284 + review_comment: *284 + self: *284 required: - comments - commits @@ -40707,8 +40889,8 @@ paths: - review_comments - review_comment - self - author_association: *83 - auto_merge: &596 + author_association: *85 + auto_merge: &598 title: Auto merge description: The status of auto merging a pull request. type: object @@ -40882,7 +41064,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &284 + content_type: &286 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -40922,7 +41104,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &286 + draft_issue: &288 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -40996,8 +41178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *279 - - *76 + - *281 + - *78 - *17 - *47 - *48 @@ -41008,7 +41190,7 @@ paths: application/json: schema: type: array - items: &283 + items: &285 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -41158,7 +41340,7 @@ paths: - updated_at - project_url examples: - default: &723 + default: &725 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41269,7 +41451,7 @@ paths: created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -41288,8 +41470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *279 - - *76 + - *281 + - *78 requestBody: required: true content: @@ -41335,7 +41517,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &724 + items: &726 type: object properties: name: @@ -41372,7 +41554,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &725 + iteration_configuration: &727 type: object description: The configuration for iteration fields. properties: @@ -41422,7 +41604,7 @@ paths: value: name: Due date data_type: date - single_select_field: &726 + single_select_field: &728 summary: Create a single select field value: name: Priority @@ -41449,7 +41631,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &727 + iteration_field: &729 summary: Create an iteration field value: name: Sprint @@ -41473,9 +41655,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *283 + schema: *285 examples: - text_field: &728 + text_field: &730 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -41484,7 +41666,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &729 + number_field: &731 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -41493,7 +41675,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &730 + date_field: &732 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -41502,7 +41684,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &731 + single_select_field: &733 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41536,7 +41718,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &732 + iteration_field: &734 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -41581,23 +41763,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *279 - - &733 + - *281 + - &735 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *283 + schema: *285 examples: - default: &734 + default: &736 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41632,7 +41814,7 @@ paths: created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -41653,8 +41835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *279 - - *76 + - *281 + - *78 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -41686,7 +41868,7 @@ paths: application/json: schema: type: array - items: &287 + items: &289 title: Projects v2 Item description: An item belonging to a project type: object @@ -41702,7 +41884,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *284 + content_type: *286 content: type: object additionalProperties: true @@ -41745,7 +41927,7 @@ paths: - updated_at - archived_at examples: - default: &288 + default: &290 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -42422,7 +42604,7 @@ paths: data_type: sub_issues_progress value: headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -42442,8 +42624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *76 - - *279 + - *78 + - *281 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -42513,22 +42695,22 @@ paths: description: Response content: application/json: - schema: *285 + schema: *287 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *286 + value: *288 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *286 + value: *288 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *286 + value: *288 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *286 + value: *288 '304': *37 '403': *29 '401': *25 @@ -42548,9 +42730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *279 - - *76 - - &289 + - *281 + - *78 + - &291 name: item_id description: The unique identifier of the project item. in: path @@ -42576,11 +42758,11 @@ paths: description: Response content: application/json: - schema: *287 + schema: *289 examples: - default: *288 + default: *290 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -42599,9 +42781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *279 - - *76 - - *289 + - *281 + - *78 + - *291 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -42671,13 +42853,13 @@ paths: description: Response content: application/json: - schema: *287 + schema: *289 examples: - text_field: *288 - number_field: *288 - date_field: *288 - single_select_field: *288 - iteration_field: *288 + text_field: *290 + number_field: *290 + date_field: *290 + single_select_field: *290 + iteration_field: *290 '401': *25 '403': *29 '404': *6 @@ -42697,9 +42879,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *279 - - *76 - - *289 + - *281 + - *78 + - *291 responses: '204': description: Response @@ -42722,8 +42904,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - - *76 - - *279 + - *78 + - *281 requestBody: required: true content: @@ -42794,7 +42976,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &715 + schema: &717 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -42892,7 +43074,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &290 + value: &292 value: id: 1 number: 1 @@ -42938,10 +43120,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *290 + value: *292 roadmap_view: summary: Response for creating a roadmap view - value: *290 + value: *292 '304': *37 '403': *29 '401': *25 @@ -42969,9 +43151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *279 - - *76 - - &735 + - *281 + - *78 + - &737 name: view_number description: The number that identifies the project view. in: path @@ -43003,11 +43185,11 @@ paths: application/json: schema: type: array - items: *287 + items: *289 examples: - default: *288 + default: *290 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -43030,7 +43212,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Response @@ -43038,7 +43220,7 @@ paths: application/json: schema: type: array - items: &291 + items: &293 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -43106,7 +43288,7 @@ paths: - property_name - value_type examples: - default: &292 + default: &294 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43155,7 +43337,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -43166,7 +43348,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *291 + items: *293 minItems: 1 maxItems: 100 required: @@ -43196,9 +43378,9 @@ paths: application/json: schema: type: array - items: *291 + items: *293 examples: - default: *292 + default: *294 '403': *29 '404': *6 x-github: @@ -43219,8 +43401,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *76 - - &293 + - *78 + - &295 name: custom_property_name description: The custom property name in: path @@ -43232,9 +43414,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *293 examples: - default: &294 + default: &296 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43268,8 +43450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *76 - - *293 + - *78 + - *295 requestBody: required: true content: @@ -43340,9 +43522,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *293 examples: - default: *294 + default: *296 '403': *29 '404': *6 x-github: @@ -43365,8 +43547,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *76 - - *293 + - *78 + - *295 responses: '204': *61 '403': *29 @@ -43389,7 +43571,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *76 + - *78 - *17 - *19 - name: repository_query @@ -43427,7 +43609,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &295 + items: &297 title: Custom Property Value description: Custom property name and associated value type: object @@ -43466,7 +43648,7 @@ paths: - property_name: team value: octocat headers: - Link: *68 + Link: *70 '403': *29 '404': *6 x-github: @@ -43494,7 +43676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *76 + - *78 requestBody: required: true content: @@ -43514,7 +43696,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *295 + items: *297 required: - repository_names - properties @@ -43555,7 +43737,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *76 + - *78 - *17 - *19 responses: @@ -43567,9 +43749,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43586,8 +43768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response if user is a public member @@ -43611,8 +43793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -43633,8 +43815,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *76 - - *72 + - *78 + - *74 responses: '204': description: Response @@ -43658,7 +43840,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *76 + - *78 - name: type description: Specifies the types of repositories you want returned. in: query @@ -43704,11 +43886,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43727,7 +43909,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *76 + - *78 requestBody: required: true content: @@ -43908,7 +44090,7 @@ paths: description: Response content: application/json: - schema: &347 + schema: &349 title: Full Repository description: Full Repository type: object @@ -44196,9 +44378,9 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *296 - required: *297 - x-github-breaking-changes: *298 + properties: *298 + required: *299 + x-github-breaking-changes: *300 nullable: true temp_clone_token: type: string @@ -44285,8 +44467,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true organization: title: Simple User @@ -44295,8 +44477,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *80 - source: *80 + parent: *82 + source: *82 forks: type: integer master_branch: @@ -44313,7 +44495,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &487 + properties: &489 url: type: string format: uri @@ -44329,12 +44511,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &488 + required: &490 - url - key - name - html_url - security_and_analysis: *299 + security_and_analysis: *301 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -44429,7 +44611,7 @@ paths: has_downloads: version: '2026-03-10' examples: - default: &349 + default: &351 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -44959,10 +45141,10 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - *17 - *19 - - &618 + - &620 name: targets description: | A comma-separated list of rule targets to filter by. @@ -44980,7 +45162,7 @@ paths: application/json: schema: type: array - items: &326 + items: &328 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -45015,7 +45197,7 @@ paths: source: type: string description: The name of the source - enforcement: &302 + enforcement: &304 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -45028,7 +45210,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &303 + items: &305 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -45098,7 +45280,7 @@ paths: conditions: nullable: true anyOf: - - &300 + - &302 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -45122,7 +45304,7 @@ paths: match. items: type: string - - &304 + - &306 title: Organization ruleset conditions type: object description: |- @@ -45136,7 +45318,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *300 + - *302 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -45170,7 +45352,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *300 + - *302 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -45192,7 +45374,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *300 + - *302 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -45205,7 +45387,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &301 + items: &303 title: Repository ruleset property targeting definition type: object @@ -45238,17 +45420,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *301 + items: *303 required: - repository_property rules: type: array - items: &619 + items: &621 title: Repository Rule type: object description: A repository rule. oneOf: - - &305 + - &307 title: creation description: Only allow users with bypass permission to create matching refs. @@ -45260,7 +45442,7 @@ paths: type: string enum: - creation - - &306 + - &308 title: update description: Only allow users with bypass permission to update matching refs. @@ -45281,7 +45463,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &307 + - &309 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -45293,7 +45475,7 @@ paths: type: string enum: - deletion - - &308 + - &310 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -45305,7 +45487,7 @@ paths: type: string enum: - required_linear_history - - &617 + - &619 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -45383,7 +45565,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &309 + - &311 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -45407,7 +45589,7 @@ paths: type: string required: - required_deployment_environments - - &310 + - &312 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -45419,7 +45601,7 @@ paths: type: string enum: - required_signatures - - &311 + - &313 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -45525,7 +45707,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &312 + - &314 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -45573,7 +45755,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &313 + - &315 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -45585,7 +45767,7 @@ paths: type: string enum: - non_fast_forward - - &314 + - &316 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -45622,7 +45804,7 @@ paths: required: - operator - pattern - - &315 + - &317 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -45659,7 +45841,7 @@ paths: required: - operator - pattern - - &316 + - &318 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -45696,7 +45878,7 @@ paths: required: - operator - pattern - - &317 + - &319 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -45733,7 +45915,7 @@ paths: required: - operator - pattern - - &318 + - &320 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -45770,7 +45952,7 @@ paths: required: - operator - pattern - - &319 + - &321 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -45795,7 +45977,7 @@ paths: type: string required: - restricted_file_paths - - &320 + - &322 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -45819,7 +46001,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &321 + - &323 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -45842,7 +46024,7 @@ paths: type: string required: - restricted_file_extensions - - &322 + - &324 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -45867,7 +46049,7 @@ paths: maximum: 100 required: - max_file_size - - &323 + - &325 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -45917,7 +46099,7 @@ paths: - repository_id required: - workflows - - &324 + - &326 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -45978,7 +46160,7 @@ paths: - tool required: - code_scanning_tools - - &325 + - &327 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -46056,7 +46238,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 requestBody: description: Request body required: true @@ -46077,22 +46259,20 @@ paths: - push - repository default: branch - enforcement: *302 + enforcement: *304 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *304 + items: *305 + conditions: *306 rules: type: array description: An array of rules within the ruleset. - items: &328 + items: &330 title: Repository Rule type: object description: A repository rule. oneOf: - - *305 - - *306 - *307 - *308 - *309 @@ -46112,6 +46292,8 @@ paths: - *323 - *324 - *325 + - *326 + - *327 required: - name - enforcement @@ -46149,9 +46331,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *328 examples: - default: &327 + default: &329 value: id: 21 name: super cool ruleset @@ -46206,8 +46388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *76 - - &620 + - *78 + - &622 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -46222,7 +46404,7 @@ paths: in: query schema: type: string - - &621 + - &623 name: time_period description: |- The time period to filter by. @@ -46238,14 +46420,14 @@ paths: - week - month default: day - - &622 + - &624 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &623 + - &625 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -46265,7 +46447,7 @@ paths: description: Response content: application/json: - schema: &624 + schema: &626 title: Rule Suites description: Response type: array @@ -46320,7 +46502,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &625 + default: &627 value: - id: 21 actor_id: 12 @@ -46363,8 +46545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *76 - - &626 + - *78 + - &628 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -46380,7 +46562,7 @@ paths: description: Response content: application/json: - schema: &627 + schema: &629 title: Rule Suite description: Response type: object @@ -46479,7 +46661,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &628 + default: &630 value: id: 21 actor_id: 12 @@ -46540,7 +46722,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46552,9 +46734,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *328 examples: - default: *327 + default: *329 '404': *6 '500': *55 put: @@ -46572,7 +46754,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46598,16 +46780,16 @@ paths: - tag - push - repository - enforcement: *302 + enforcement: *304 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *304 + items: *305 + conditions: *306 rules: description: An array of rules within the ruleset. type: array - items: *328 + items: *330 examples: default: value: @@ -46642,9 +46824,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *328 examples: - default: *327 + default: *329 '404': *6 '422': *15 '500': *55 @@ -46663,7 +46845,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46686,7 +46868,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *76 + - *78 - *17 - *19 - name: ruleset_id @@ -46702,7 +46884,7 @@ paths: application/json: schema: type: array - items: &329 + items: &331 title: Ruleset version type: object description: The historical version of a ruleset @@ -46726,7 +46908,7 @@ paths: type: string format: date-time examples: - default: &630 + default: &632 value: - version_id: 3 actor: @@ -46761,7 +46943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *76 + - *78 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46779,9 +46961,9 @@ paths: description: Response content: application/json: - schema: &631 + schema: &633 allOf: - - *329 + - *331 - type: object required: - state @@ -46850,8 +47032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *76 - - &632 + - *78 + - &634 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -46862,7 +47044,7 @@ paths: enum: - open - resolved - - &633 + - &635 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -46872,7 +47054,7 @@ paths: required: false schema: type: string - - &634 + - &636 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -46883,7 +47065,7 @@ paths: required: false schema: type: string - - &635 + - &637 name: exclude_providers in: query description: |- @@ -46894,7 +47076,7 @@ paths: required: false schema: type: string - - &636 + - &638 name: providers in: query description: |- @@ -46905,7 +47087,7 @@ paths: required: false schema: type: string - - &637 + - &639 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46914,7 +47096,7 @@ paths: required: false schema: type: string - - &638 + - &640 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46933,7 +47115,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &639 + - &641 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -46948,7 +47130,7 @@ paths: - *62 - *19 - *17 - - &640 + - &642 name: before 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 @@ -46958,7 +47140,7 @@ paths: required: false schema: type: string - - &641 + - &643 name: after 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 @@ -46968,7 +47150,7 @@ paths: required: false schema: type: string - - &642 + - &644 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46977,7 +47159,7 @@ paths: required: false schema: type: string - - &643 + - &645 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46986,7 +47168,7 @@ paths: schema: type: boolean default: false - - &644 + - &646 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46995,7 +47177,7 @@ paths: schema: type: boolean default: false - - &645 + - &647 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -47014,8 +47196,8 @@ paths: items: type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -47023,21 +47205,21 @@ paths: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &646 + state: &648 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &647 + resolution: &649 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -47154,8 +47336,8 @@ paths: pull request. ' - oneOf: &648 - - &650 + oneOf: &650 + - &652 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -47213,7 +47395,7 @@ paths: - blob_url - commit_sha - commit_url - - &651 + - &653 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -47268,7 +47450,7 @@ paths: - page_url - commit_sha - commit_url - - &652 + - &654 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -47288,7 +47470,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &653 + - &655 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -47308,7 +47490,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &654 + - &656 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -47328,7 +47510,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &655 + - &657 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -47342,7 +47524,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &656 + - &658 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -47356,7 +47538,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &657 + - &659 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -47370,7 +47552,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &658 + - &660 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -47390,7 +47572,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &659 + - &661 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -47410,7 +47592,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &660 + - &662 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -47430,7 +47612,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &661 + - &663 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -47450,7 +47632,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &662 + - &664 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -47674,9 +47856,9 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47701,7 +47883,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *78 responses: '200': description: Response @@ -47713,7 +47895,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &331 + pattern_config_version: &333 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -47722,7 +47904,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &330 + items: &332 type: object properties: token_type: @@ -47788,7 +47970,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *330 + items: *332 examples: default: value: @@ -47837,7 +48019,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *78 requestBody: required: true content: @@ -47845,7 +48027,7 @@ paths: schema: type: object properties: - pattern_config_version: *331 + pattern_config_version: *333 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -47871,7 +48053,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *331 + custom_pattern_version: *333 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -47925,7 +48107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *76 + - *78 - *62 - name: sort description: The property to sort the results by. @@ -47969,7 +48151,7 @@ paths: application/json: schema: type: array - items: &666 + items: &668 description: A repository security advisory. type: object properties: @@ -48189,7 +48371,7 @@ paths: login: type: string description: The username of the user credited. - type: *332 + type: *334 credits_detailed: type: array nullable: true @@ -48199,7 +48381,7 @@ paths: type: object properties: user: *4 - type: *332 + type: *334 state: type: string description: The state of the user's acceptance of the @@ -48223,7 +48405,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *195 + items: *197 private_fork: readOnly: true nullable: true @@ -48292,7 +48474,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &667 + default: &669 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -48671,7 +48853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *76 + - *78 responses: '200': description: Response @@ -48679,7 +48861,7 @@ paths: application/json: schema: type: array - items: *333 + items: *335 examples: default: value: @@ -48719,8 +48901,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -48745,8 +48927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response @@ -48773,7 +48955,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *76 + - *78 responses: '200': description: Immutable releases settings response @@ -48822,7 +49004,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *76 + - *78 responses: '204': description: Response @@ -48879,7 +49061,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *76 + - *78 - *19 - *17 responses: @@ -48897,9 +49079,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *171 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48918,7 +49100,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *76 + - *78 requestBody: required: true content: @@ -48967,8 +49149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -48990,8 +49172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *76 - - *148 + - *78 + - *150 responses: '204': description: Response @@ -49014,7 +49196,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *76 + - *78 - *17 - *19 responses: @@ -49032,7 +49214,7 @@ paths: type: integer network_configurations: type: array - items: &334 + items: &336 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -49103,7 +49285,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49122,7 +49304,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 + - *78 requestBody: required: true content: @@ -49178,9 +49360,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: &335 + default: &337 value: id: 123456789ABCDEF name: My network configuration @@ -49208,8 +49390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 - - &336 + - *78 + - &338 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -49221,11 +49403,11 @@ paths: description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: *335 + default: *337 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49244,8 +49426,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *76 - - *336 + - *78 + - *338 requestBody: required: true content: @@ -49298,9 +49480,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: *335 + default: *337 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49319,8 +49501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *76 - - *336 + - *78 + - *338 responses: '204': description: Response @@ -49343,7 +49525,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *76 + - *78 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -49397,7 +49579,7 @@ paths: subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" region: eastus headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49427,8 +49609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *76 - *78 + - *80 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -49460,13 +49642,13 @@ paths: application/json: schema: type: array - items: *337 + items: *339 examples: - default: *338 + default: *340 '500': *55 '403': *29 '404': *6 - '422': *339 + '422': *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49484,7 +49666,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *76 + - *78 - *17 - *19 - name: team_type @@ -49506,11 +49688,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *260 + default: *262 headers: - Link: *68 + Link: *70 '403': *29 x-github: githubCloudOnly: false @@ -49530,7 +49712,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *76 + - *78 requestBody: required: true content: @@ -49602,7 +49784,7 @@ paths: description: Response content: application/json: - schema: &340 + schema: &342 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -49665,8 +49847,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *258 - required: *259 + properties: *260 + required: *261 nullable: true members_count: type: integer @@ -49929,7 +50111,7 @@ paths: - repos_count - organization examples: - default: &341 + default: &343 value: id: 1 node_id: MDQ6VGVhbTE= @@ -50010,16 +50192,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *76 - *78 + - *80 responses: '200': description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *341 + default: *343 '404': *6 x-github: githubCloudOnly: false @@ -50040,8 +50222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *76 - *78 + - *80 requestBody: required: false content: @@ -50103,16 +50285,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *340 + schema: *342 examples: - default: *341 + default: *343 '201': description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *341 + default: *343 '404': *6 '422': *15 '403': *29 @@ -50137,12 +50319,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *76 - *78 + - *80 responses: '204': description: Response - '422': &342 + '422': &344 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -50165,8 +50347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -50176,12 +50358,12 @@ paths: application/json: schema: type: array - items: *237 + items: *239 examples: - default: *238 + default: *240 headers: - Link: *68 - '422': *342 + Link: *70 + '422': *344 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50201,8 +50383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *76 - *78 + - *80 - name: role description: Filters members returned by their role in the team. in: query @@ -50225,9 +50407,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50255,15 +50437,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 responses: '200': description: Response content: application/json: - schema: &343 + schema: &345 title: Team Membership description: Team Membership type: object @@ -50290,7 +50472,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &682 + response-if-user-is-a-team-maintainer: &684 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -50326,9 +50508,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 requestBody: required: false content: @@ -50353,9 +50535,9 @@ paths: description: Response content: application/json: - schema: *343 + schema: *345 examples: - response-if-users-membership-with-team-is-now-pending: &683 + response-if-users-membership-with-team-is-now-pending: &685 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -50390,9 +50572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *76 - *78 - - *72 + - *80 + - *74 responses: '204': description: Response @@ -50418,8 +50600,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -50429,11 +50611,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50460,16 +50642,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *76 - *78 - - *344 - - *345 + - *80 + - *346 + - *347 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &684 + schema: &686 title: Team Repository description: A team's access to a repository. type: object @@ -50492,8 +50674,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true forks: type: integer @@ -51123,10 +51305,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *76 - *78 - - *344 - - *345 + - *80 + - *346 + - *347 requestBody: required: false content: @@ -51171,10 +51353,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *76 - *78 - - *344 - - *345 + - *80 + - *346 + - *347 responses: '204': description: Response @@ -51198,8 +51380,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *76 - *78 + - *80 - *17 - *19 responses: @@ -51209,9 +51391,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - response-if-child-teams-exist: &685 + response-if-child-teams-exist: &687 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -51239,7 +51421,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51264,7 +51446,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *76 + - *78 - name: security_product in: path description: The security feature to enable or disable. @@ -51365,7 +51547,7 @@ paths: resources: type: object properties: - core: &346 + core: &348 title: Rate Limit type: object properties: @@ -51382,21 +51564,21 @@ paths: - remaining - reset - used - graphql: *346 - search: *346 - code_search: *346 - source_import: *346 - integration_manifest: *346 - code_scanning_upload: *346 - actions_runner_registration: *346 - scim: *346 - dependency_snapshots: *346 - dependency_sbom: *346 - code_scanning_autofix: *346 + graphql: *348 + search: *348 + code_search: *348 + source_import: *348 + integration_manifest: *348 + code_scanning_upload: *348 + actions_runner_registration: *348 + scim: *348 + dependency_snapshots: *348 + dependency_sbom: *348 + code_scanning_autofix: *348 required: - core - search - rate: *346 + rate: *348 required: - rate - resources @@ -51515,14 +51697,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *347 + schema: *349 examples: default-response: summary: Default response @@ -52033,7 +52215,7 @@ paths: version: '2026-03-10' '403': *29 '404': *6 - '301': *348 + '301': *350 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52051,8 +52233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: false content: @@ -52350,10 +52532,10 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *349 - '307': &350 + default: *351 + '307': &352 description: Temporary Redirect content: application/json: @@ -52382,8 +52564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -52405,7 +52587,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *350 + '307': *352 '404': *6 '409': *54 x-github: @@ -52429,11 +52611,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 - - &383 + - &385 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -52456,7 +52638,7 @@ paths: type: integer artifacts: type: array - items: &351 + items: &353 title: Artifact description: An artifact type: object @@ -52534,7 +52716,7 @@ paths: - expires_at - updated_at examples: - default: &384 + default: &386 value: total_count: 2 artifacts: @@ -52573,7 +52755,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52595,9 +52777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *344 - - *345 - - &352 + - *346 + - *347 + - &354 name: artifact_id description: The unique identifier of the artifact. in: path @@ -52609,7 +52791,7 @@ paths: description: Response content: application/json: - schema: *351 + schema: *353 examples: default: value: @@ -52647,9 +52829,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *344 - - *345 - - *352 + - *346 + - *347 + - *354 responses: '204': description: Response @@ -52673,9 +52855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *344 - - *345 - - *352 + - *346 + - *347 + - *354 - name: archive_format in: path required: true @@ -52685,11 +52867,11 @@ paths: '302': description: Response headers: - Location: &506 + Location: &508 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &547 + '410': &549 description: Gone content: application/json: @@ -52714,14 +52896,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: &353 + schema: &355 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -52754,13 +52936,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: application/json: - schema: *353 + schema: *355 examples: selected_actions: *42 responses: @@ -52789,14 +52971,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: &354 + schema: &356 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -52829,13 +53011,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: application/json: - schema: *354 + schema: *356 examples: selected_actions: *44 responses: @@ -52866,14 +53048,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *355 + schema: *357 examples: default: value: @@ -52899,11 +53081,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 - - &356 + - &358 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -52937,7 +53119,7 @@ paths: description: Response content: application/json: - schema: &357 + schema: &359 title: Repository actions caches description: Repository actions caches type: object @@ -52979,7 +53161,7 @@ paths: - total_count - actions_caches examples: - default: &358 + default: &360 value: total_count: 1 actions_caches: @@ -52991,7 +53173,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53011,23 +53193,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *344 - - *345 + - *346 + - *347 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *356 + - *358 responses: '200': description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *358 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53047,8 +53229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *344 - - *345 + - *346 + - *347 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -53079,9 +53261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *344 - - *345 - - &359 + - *346 + - *347 + - &361 name: job_id description: The unique identifier of the job. in: path @@ -53093,7 +53275,7 @@ paths: description: Response content: application/json: - schema: &387 + schema: &389 title: Job description: Information of a job execution in a workflow run type: object @@ -53400,9 +53582,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *344 - - *345 - - *359 + - *346 + - *347 + - *361 responses: '302': description: Response @@ -53430,9 +53612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *344 - - *345 - - *359 + - *346 + - *347 + - *361 requestBody: required: false content: @@ -53453,7 +53635,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -53477,8 +53659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Status response @@ -53499,6 +53681,15 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable + OIDC subject claim format. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. If not set at the + repository level, falls back to the organization-level setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default examples: @@ -53528,8 +53719,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -53551,6 +53742,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -53563,7 +53759,7 @@ paths: description: Empty response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -53592,8 +53788,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -53611,7 +53807,7 @@ paths: type: integer secrets: type: array - items: &389 + items: &391 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -53631,7 +53827,7 @@ paths: - created_at - updated_at examples: - default: &390 + default: &392 value: total_count: 2 secrets: @@ -53642,7 +53838,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53664,9 +53860,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *344 - - *345 - - *360 + - *346 + - *347 + - *362 - *19 responses: '200': @@ -53683,7 +53879,7 @@ paths: type: integer variables: type: array - items: &393 + items: &395 title: Actions Variable type: object properties: @@ -53713,7 +53909,7 @@ paths: - created_at - updated_at examples: - default: &394 + default: &396 value: total_count: 2 variables: @@ -53726,7 +53922,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53746,8 +53942,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -53756,12 +53952,12 @@ paths: schema: type: object properties: - enabled: &362 + enabled: &364 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *144 - selected_actions_url: *361 - sha_pinning_required: *145 + allowed_actions: *146 + selected_actions_url: *363 + sha_pinning_required: *147 required: - enabled examples: @@ -53789,8 +53985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -53801,9 +53997,9 @@ paths: schema: type: object properties: - enabled: *362 - allowed_actions: *144 - sha_pinning_required: *145 + enabled: *364 + allowed_actions: *146 + sha_pinning_required: *147 required: - enabled examples: @@ -53833,14 +54029,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: &363 + schema: &365 type: object properties: access_level: @@ -53857,7 +54053,7 @@ paths: required: - access_level examples: - default: &364 + default: &366 value: access_level: organization x-github: @@ -53881,15 +54077,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: application/json: - schema: *363 + schema: *365 examples: - default: *364 + default: *366 responses: '204': description: Response @@ -53913,14 +54109,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *365 + schema: *367 examples: default: value: @@ -53944,8 +54140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Empty response for successful settings update @@ -53955,7 +54151,7 @@ paths: required: true content: application/json: - schema: *366 + schema: *368 examples: default: summary: Set retention days @@ -53979,16 +54175,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *146 + schema: *148 examples: - default: *367 + default: *369 '404': *6 x-github: enabledForGitHubApps: true @@ -54007,8 +54203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -54018,7 +54214,7 @@ paths: required: true content: application/json: - schema: *146 + schema: *148 examples: default: summary: Set approval policy to first time contributors @@ -54042,16 +54238,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *368 + schema: *370 examples: - default: *147 + default: *149 '403': *29 '404': *6 x-github: @@ -54071,15 +54267,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: application/json: - schema: *369 + schema: *371 examples: - default: *147 + default: *149 responses: '204': description: Empty response for successful settings update @@ -54103,16 +54299,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *149 + schema: *151 examples: - default: *150 + default: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54131,8 +54327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -54140,9 +54336,9 @@ paths: required: false content: application/json: - schema: *149 + schema: *151 examples: - selected_actions: *150 + selected_actions: *152 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54164,16 +54360,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *370 + schema: *372 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54194,8 +54390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Success response @@ -54206,9 +54402,9 @@ paths: required: true content: application/json: - schema: *371 + schema: *373 examples: - default: *154 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54235,8 +54431,8 @@ paths: in: query schema: type: string - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -54254,11 +54450,11 @@ paths: type: integer runners: type: array - items: *161 + items: *163 examples: - default: *162 + default: *164 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54280,8 +54476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -54289,9 +54485,9 @@ paths: application/json: schema: type: array - items: *372 + items: *374 examples: - default: *373 + default: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54313,8 +54509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -54357,7 +54553,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *374 + '201': *376 '404': *6 '422': *7 '409': *54 @@ -54388,16 +54584,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: *375 + default: *377 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54425,16 +54621,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '201': description: Response content: application/json: - schema: *163 + schema: *165 examples: - default: *376 + default: *378 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54456,17 +54652,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *344 - - *345 - - *160 + - *346 + - *347 + - *162 responses: '200': description: Response content: application/json: - schema: *161 + schema: *163 examples: - default: *377 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54487,9 +54683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *344 - - *345 - - *160 + - *346 + - *347 + - *162 responses: '204': description: Response @@ -54515,11 +54711,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *344 - - *345 - - *160 + - *346 + - *347 + - *162 responses: - '200': *165 + '200': *167 '404': *6 x-github: githubCloudOnly: false @@ -54541,9 +54737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *344 - - *345 - - *160 + - *346 + - *347 + - *162 requestBody: required: true content: @@ -54567,7 +54763,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -54591,9 +54787,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *344 - - *345 - - *160 + - *346 + - *347 + - *162 requestBody: required: true content: @@ -54618,7 +54814,7 @@ paths: - gpu - accelerated responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -54642,11 +54838,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *344 - - *345 - - *160 + - *346 + - *347 + - *162 responses: - '200': *378 + '200': *380 '404': *6 x-github: githubCloudOnly: false @@ -54673,12 +54869,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *344 - - *345 - - *160 - - *379 + - *346 + - *347 + - *162 + - *381 responses: - '200': *165 + '200': *167 '404': *6 '422': *7 x-github: @@ -54704,9 +54900,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *344 - - *345 - - &397 + - *346 + - *347 + - &399 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -54714,7 +54910,7 @@ paths: required: false schema: type: string - - &398 + - &400 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -54722,7 +54918,7 @@ paths: required: false schema: type: string - - &399 + - &401 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -54731,7 +54927,7 @@ paths: required: false schema: type: string - - &400 + - &402 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -54758,7 +54954,7 @@ paths: - pending - *17 - *19 - - &401 + - &403 name: created 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)." @@ -54767,7 +54963,7 @@ paths: schema: type: string format: date-time - - &380 + - &382 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -54776,13 +54972,13 @@ paths: schema: type: boolean default: false - - &402 + - &404 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &403 + - &405 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -54805,7 +55001,7 @@ paths: type: integer workflow_runs: type: array - items: &381 + items: &383 title: Workflow Run description: An invocation of a workflow type: object @@ -54900,7 +55096,7 @@ paths: that triggered the run. type: array nullable: true - items: *91 + items: *93 created_at: type: string format: date-time @@ -54953,7 +55149,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &425 + properties: &427 id: type: string description: SHA for the commit @@ -55004,7 +55200,7 @@ paths: - name - email nullable: true - required: &426 + required: &428 - id - tree_id - message @@ -55012,8 +55208,8 @@ paths: - author - committer nullable: true - repository: *159 - head_repository: *159 + repository: *161 + head_repository: *161 head_repository_id: type: integer example: 5 @@ -55051,7 +55247,7 @@ paths: - workflow_url - pull_requests examples: - default: &404 + default: &406 value: total_count: 1 workflow_runs: @@ -55265,7 +55461,7 @@ paths: releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55287,24 +55483,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *344 - - *345 - - &382 + - *346 + - *347 + - &384 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *380 + - *382 responses: '200': description: Response content: application/json: - schema: *381 + schema: *383 examples: - default: &385 + default: &387 value: id: 30433642 name: Build @@ -55545,9 +55741,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '204': description: Response @@ -55570,9 +55766,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '200': description: Response @@ -55691,15 +55887,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -55726,12 +55922,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 - *17 - *19 - - *383 + - *385 - *62 responses: '200': @@ -55748,11 +55944,11 @@ paths: type: integer artifacts: type: array - items: *351 + items: *353 examples: - default: *384 + default: *386 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55774,25 +55970,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *344 - - *345 - - *382 - - &386 + - *346 + - *347 + - *384 + - &388 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *380 + - *382 responses: '200': description: Response content: application/json: - schema: *381 + schema: *383 examples: - default: *385 + default: *387 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55815,10 +56011,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *344 - - *345 - - *382 - - *386 + - *346 + - *347 + - *384 + - *388 - *17 - *19 responses: @@ -55836,9 +56032,9 @@ paths: type: integer jobs: type: array - items: *387 + items: *389 examples: - default: &388 + default: &390 value: total_count: 1 jobs: @@ -55927,7 +56123,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -55951,10 +56147,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *344 - - *345 - - *382 - - *386 + - *346 + - *347 + - *384 + - *388 responses: '302': description: Response @@ -55982,15 +56178,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '202': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56017,9 +56213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 requestBody: required: true content: @@ -56086,15 +56282,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '202': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56121,9 +56317,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -56153,11 +56349,11 @@ paths: type: integer jobs: type: array - items: *387 + items: *389 examples: - default: *388 + default: *390 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56180,9 +56376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '302': description: Response @@ -56209,9 +56405,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '204': description: Response @@ -56238,9 +56434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '200': description: Response @@ -56300,7 +56496,7 @@ paths: items: type: object properties: - type: &513 + type: &515 type: string description: The type of reviewer. enum: @@ -56310,7 +56506,7 @@ paths: reviewer: anyOf: - *4 - - *195 + - *197 required: - environment - wait_timer @@ -56385,9 +56581,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 requestBody: required: true content: @@ -56434,12 +56630,12 @@ paths: application/json: schema: type: array - items: &508 + items: &510 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &755 + properties: &757 url: type: string format: uri @@ -56522,9 +56718,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - required: &756 + properties: *83 + required: *84 + required: &758 - id - node_id - sha @@ -56540,7 +56736,7 @@ paths: - created_at - updated_at examples: - default: &509 + default: &511 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -56596,9 +56792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 requestBody: required: false content: @@ -56619,7 +56815,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56642,9 +56838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 requestBody: required: false content: @@ -56665,7 +56861,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -56697,9 +56893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *344 - - *345 - - *382 + - *346 + - *347 + - *384 responses: '200': description: Response @@ -56836,8 +57032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -56855,11 +57051,11 @@ paths: type: integer secrets: type: array - items: *389 + items: *391 examples: - default: *390 + default: *392 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56882,16 +57078,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *391 + schema: *393 examples: - default: *392 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56913,17 +57109,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 responses: '200': description: Response content: application/json: - schema: *389 + schema: *391 examples: - default: &526 + default: &528 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -56949,9 +57145,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 requestBody: required: true content: @@ -56982,7 +57178,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -57008,9 +57204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 responses: '204': description: Response @@ -57035,9 +57231,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *344 - - *345 - - *360 + - *346 + - *347 + - *362 - *19 responses: '200': @@ -57054,11 +57250,11 @@ paths: type: integer variables: type: array - items: *393 + items: *395 examples: - default: *394 + default: *396 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57079,8 +57275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -57107,7 +57303,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -57132,17 +57328,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *344 - - *345 - - *170 + - *346 + - *347 + - *172 responses: '200': description: Response content: application/json: - schema: *393 + schema: *395 examples: - default: &527 + default: &529 value: name: USERNAME value: octocat @@ -57168,9 +57364,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *344 - - *345 - - *170 + - *346 + - *347 + - *172 requestBody: required: true content: @@ -57212,9 +57408,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *344 - - *345 - - *170 + - *346 + - *347 + - *172 responses: '204': description: Response @@ -57239,8 +57435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -57258,7 +57454,7 @@ paths: type: integer workflows: type: array - items: &395 + items: &397 title: Workflow description: A GitHub Actions workflow type: object @@ -57342,7 +57538,7 @@ paths: html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57365,9 +57561,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *344 - - *345 - - &396 + - *346 + - *347 + - &398 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -57382,7 +57578,7 @@ paths: description: Response content: application/json: - schema: *395 + schema: *397 examples: default: value: @@ -57415,9 +57611,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *344 - - *345 - - *396 + - *346 + - *347 + - *398 responses: '204': description: Response @@ -57442,9 +57638,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *344 - - *345 - - *396 + - *346 + - *347 + - *398 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -57524,6 +57720,9 @@ paths: path: "/responses/204" - op: remove path: "/requestBody/content/application~1json/schema/properties/return_run_details" + - op: replace + path: "/responses/200/description" + value: Response including the workflow run ID and URLs. version: '2026-03-10' "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": put: @@ -57539,9 +57738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *344 - - *345 - - *396 + - *346 + - *347 + - *398 responses: '204': description: Response @@ -57568,19 +57767,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *344 - - *345 - - *396 - - *397 + - *346 + - *347 - *398 - *399 - *400 - - *17 - - *19 - *401 - - *380 - *402 + - *17 + - *19 - *403 + - *382 + - *404 + - *405 responses: '200': description: Response @@ -57596,11 +57795,11 @@ paths: type: integer workflow_runs: type: array - items: *381 + items: *383 examples: - default: *404 + default: *406 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57630,9 +57829,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *344 - - *345 - - *396 + - *346 + - *347 + - *398 responses: '200': description: Response @@ -57693,8 +57892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *344 - - *345 + - *346 + - *347 - *62 - *17 - *47 @@ -57839,7 +58038,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '422': *7 x-github: githubCloudOnly: false @@ -57858,8 +58057,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -57871,9 +58070,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -57896,8 +58095,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *344 - - *345 + - *346 + - *347 - name: assignee in: path required: true @@ -57933,8 +58132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -58044,8 +58243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *47 - *48 @@ -58102,7 +58301,7 @@ paths: initiator: type: string examples: - default: *405 + default: *407 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58136,8 +58335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -58145,7 +58344,7 @@ paths: application/json: schema: type: array - items: &406 + items: &408 title: Autolink reference description: An autolink reference. type: object @@ -58199,8 +58398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -58239,9 +58438,9 @@ paths: description: response content: application/json: - schema: *406 + schema: *408 examples: - default: &407 + default: &409 value: id: 1 key_prefix: TICKET- @@ -58272,9 +58471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *344 - - *345 - - &408 + - *346 + - *347 + - &410 name: autolink_id description: The unique identifier of the autolink. in: path @@ -58286,9 +58485,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *408 examples: - default: *407 + default: *409 '404': *6 x-github: githubCloudOnly: false @@ -58308,9 +58507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *344 - - *345 - - *408 + - *346 + - *347 + - *410 responses: '204': description: Response @@ -58334,8 +58533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response if Dependabot is enabled @@ -58383,8 +58582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -58405,8 +58604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -58426,8 +58625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *344 - - *345 + - *346 + - *347 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -58465,7 +58664,7 @@ paths: - url protected: type: boolean - protection: &410 + protection: &412 title: Branch Protection description: Branch Protection type: object @@ -58507,7 +58706,7 @@ paths: required: - contexts - checks - enforce_admins: &413 + enforce_admins: &415 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -58522,7 +58721,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &415 + required_pull_request_reviews: &417 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -58543,7 +58742,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *195 + items: *197 apps: description: The list of apps with review dismissal access. @@ -58572,7 +58771,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *195 + items: *197 apps: description: The list of apps allowed to bypass pull request requirements. @@ -58598,7 +58797,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &412 + restrictions: &414 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -58661,7 +58860,7 @@ paths: type: string teams: type: array - items: *195 + items: *197 apps: type: array items: @@ -58857,7 +59056,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -58875,9 +59074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *344 - - *345 - - &411 + - *346 + - *347 + - &413 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -58891,14 +59090,14 @@ paths: description: Response content: application/json: - schema: &421 + schema: &423 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &478 + commit: &480 title: Commit description: Commit type: object @@ -58932,7 +59131,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &409 + properties: &411 name: type: string example: '"Chris Wanstrath"' @@ -58948,7 +59147,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *409 + properties: *411 nullable: true message: type: string @@ -58969,7 +59168,7 @@ paths: required: - sha - url - verification: &533 + verification: &535 title: Verification type: object properties: @@ -59003,12 +59202,12 @@ paths: nullable: true oneOf: - *4 - - *168 + - *170 committer: nullable: true oneOf: - *4 - - *168 + - *170 parents: type: array items: @@ -59039,7 +59238,7 @@ paths: type: integer files: type: array - items: &491 + items: &493 title: Diff Entry description: Diff Entry type: object @@ -59123,7 +59322,7 @@ paths: - self protected: type: boolean - protection: *410 + protection: *412 protection_url: type: string format: uri @@ -59230,7 +59429,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *348 + '301': *350 '404': *6 x-github: githubCloudOnly: false @@ -59252,15 +59451,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response content: application/json: - schema: *410 + schema: *412 examples: default: value: @@ -59454,9 +59653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: true content: @@ -59711,7 +59910,7 @@ paths: url: type: string format: uri - required_status_checks: &418 + required_status_checks: &420 title: Status Check Policy description: Status Check Policy type: object @@ -59787,7 +59986,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 apps: type: array items: *5 @@ -59805,7 +60004,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 apps: type: array items: *5 @@ -59863,7 +60062,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *412 + restrictions: *414 required_conversation_resolution: type: object properties: @@ -59975,9 +60174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '204': description: Response @@ -60002,17 +60201,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response content: application/json: - schema: *413 + schema: *415 examples: - default: &414 + default: &416 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -60034,17 +60233,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response content: application/json: - schema: *413 + schema: *415 examples: - default: *414 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60063,9 +60262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '204': description: Response @@ -60090,17 +60289,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response content: application/json: - schema: *415 + schema: *417 examples: - default: &416 + default: &418 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -60196,9 +60395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: false content: @@ -60296,9 +60495,9 @@ paths: description: Response content: application/json: - schema: *415 + schema: *417 examples: - default: *416 + default: *418 '422': *15 x-github: githubCloudOnly: false @@ -60319,9 +60518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '204': description: Response @@ -60348,17 +60547,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response content: application/json: - schema: *413 + schema: *415 examples: - default: &417 + default: &419 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -60381,17 +60580,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response content: application/json: - schema: *413 + schema: *415 examples: - default: *417 + default: *419 '404': *6 x-github: githubCloudOnly: false @@ -60411,9 +60610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '204': description: Response @@ -60438,17 +60637,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response content: application/json: - schema: *418 + schema: *420 examples: - default: &419 + default: &421 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -60474,9 +60673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: false content: @@ -60528,9 +60727,9 @@ paths: description: Response content: application/json: - schema: *418 + schema: *420 examples: - default: *419 + default: *421 '404': *6 '422': *15 x-github: @@ -60552,9 +60751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '204': description: Response @@ -60578,9 +60777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response @@ -60614,9 +60813,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: false content: @@ -60683,9 +60882,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: false content: @@ -60749,9 +60948,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: content: application/json: @@ -60817,15 +61016,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response content: application/json: - schema: *412 + schema: *414 examples: default: value: @@ -60916,9 +61115,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '204': description: Response @@ -60941,9 +61140,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response @@ -60953,7 +61152,7 @@ paths: type: array items: *5 examples: - default: &420 + default: &422 value: - id: 1 slug: octoapp @@ -61010,9 +61209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: true content: @@ -61046,7 +61245,7 @@ paths: type: array items: *5 examples: - default: *420 + default: *422 '422': *15 x-github: githubCloudOnly: false @@ -61067,9 +61266,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: true content: @@ -61103,7 +61302,7 @@ paths: type: array items: *5 examples: - default: *420 + default: *422 '422': *15 x-github: githubCloudOnly: false @@ -61124,9 +61323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: true content: @@ -61160,7 +61359,7 @@ paths: type: array items: *5 examples: - default: *420 + default: *422 '422': *15 x-github: githubCloudOnly: false @@ -61182,9 +61381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response @@ -61192,9 +61391,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *260 + default: *262 '404': *6 x-github: githubCloudOnly: false @@ -61214,9 +61413,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: false content: @@ -61252,9 +61451,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *260 + default: *262 '422': *15 x-github: githubCloudOnly: false @@ -61275,9 +61474,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: false content: @@ -61313,9 +61512,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *260 + default: *262 '422': *15 x-github: githubCloudOnly: false @@ -61336,9 +61535,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: content: application/json: @@ -61373,9 +61572,9 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *260 + default: *262 '422': *15 x-github: githubCloudOnly: false @@ -61397,9 +61596,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 responses: '200': description: Response @@ -61409,7 +61608,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '404': *6 x-github: githubCloudOnly: false @@ -61433,9 +61632,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: true content: @@ -61468,7 +61667,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -61493,9 +61692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: true content: @@ -61528,7 +61727,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -61553,9 +61752,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: true content: @@ -61588,7 +61787,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '422': *15 x-github: githubCloudOnly: false @@ -61615,9 +61814,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 requestBody: required: true content: @@ -61639,7 +61838,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *423 examples: default: value: @@ -61755,8 +61954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -62035,7 +62234,7 @@ paths: description: Response content: application/json: - schema: &422 + schema: &424 title: CheckRun description: A check performed on the code of a given code change type: object @@ -62146,16 +62345,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *91 - deployment: &748 + items: *93 + deployment: &750 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -62222,8 +62421,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -62435,9 +62634,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *344 - - *345 - - &423 + - *346 + - *347 + - &425 name: check_run_id description: The unique identifier of the check run. in: path @@ -62449,9 +62648,9 @@ paths: description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: &424 + default: &426 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -62551,9 +62750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *344 - - *345 - - *423 + - *346 + - *347 + - *425 requestBody: required: true content: @@ -62793,9 +62992,9 @@ paths: description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: *424 + default: *426 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62815,9 +63014,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *344 - - *345 - - *423 + - *346 + - *347 + - *425 - *17 - *19 responses: @@ -62892,7 +63091,7 @@ paths: raw_details: Do you mean 'bananas' or 'banana'? blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62912,15 +63111,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *344 - - *345 - - *423 + - *346 + - *347 + - *425 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -62958,8 +63157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -62981,7 +63180,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &427 + schema: &429 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -63045,7 +63244,7 @@ paths: nullable: true pull_requests: type: array - items: *91 + items: *93 nullable: true app: title: GitHub app @@ -63056,9 +63255,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - repository: *159 + properties: *83 + required: *84 + repository: *161 created_at: type: string format: date-time @@ -63067,12 +63266,12 @@ paths: type: string format: date-time nullable: true - head_commit: &776 + head_commit: &778 title: Simple Commit description: A commit. type: object - properties: *425 - required: *426 + properties: *427 + required: *428 latest_check_runs_count: type: integer check_runs_url: @@ -63100,7 +63299,7 @@ paths: - check_runs_url - pull_requests examples: - default: &428 + default: &430 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -63391,9 +63590,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *427 + schema: *429 examples: - default: *428 + default: *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63412,8 +63611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -63474,7 +63673,7 @@ paths: required: - app_id - setting - repository: *159 + repository: *161 examples: default: value: @@ -63722,9 +63921,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *344 - - *345 - - &429 + - *346 + - *347 + - &431 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -63736,9 +63935,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *429 examples: - default: *428 + default: *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63761,17 +63960,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *344 - - *345 - - *429 - - &484 + - *346 + - *347 + - *431 + - &486 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &485 + - &487 name: status description: Returns check runs with the specified `status`. in: query @@ -63810,9 +64009,9 @@ paths: type: integer check_runs: type: array - items: *422 + items: *424 examples: - default: &486 + default: &488 value: total_count: 1 check_runs: @@ -63894,7 +64093,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63914,15 +64113,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *344 - - *345 - - *429 + - *346 + - *347 + - *431 responses: '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -63949,21 +64148,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *344 - - *345 - - *430 - - *431 + - *346 + - *347 + - *432 + - *433 - *19 - *17 - - &448 + - &450 name: ref 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`. in: query required: false - schema: *432 - - &449 + schema: *434 + - &451 name: pr description: The number of the pull request for the results you want to list. in: query @@ -63988,13 +64187,13 @@ paths: be returned. in: query required: false - schema: *433 + schema: *435 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *434 + schema: *436 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -64013,14 +64212,14 @@ paths: items: type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: *435 - state: *186 - fixed_at: *182 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: *437 + state: *188 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -64028,12 +64227,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: *436 - dismissed_comment: *437 - rule: *438 - tool: *439 - most_recent_instance: *440 + dismissed_at: *185 + dismissed_reason: *438 + dismissed_comment: *439 + rule: *440 + tool: *441 + most_recent_instance: *442 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -64159,14 +64358,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &441 + '403': &443 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64186,9 +64385,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *344 - - *345 - - &442 + - *346 + - *347 + - &444 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -64196,23 +64395,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *177 + schema: *179 responses: '200': description: Response content: application/json: - schema: &443 + schema: &445 type: object properties: - number: *177 - created_at: *178 - updated_at: *179 - url: *180 - html_url: *181 - instances_url: *435 - state: *186 - fixed_at: *182 + number: *179 + created_at: *180 + updated_at: *181 + url: *182 + html_url: *183 + instances_url: *437 + state: *188 + fixed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -64220,9 +64419,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *183 - dismissed_reason: *436 - dismissed_comment: *437 + dismissed_at: *185 + dismissed_reason: *438 + dismissed_comment: *439 rule: type: object properties: @@ -64276,8 +64475,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *439 - most_recent_instance: *440 + tool: *441 + most_recent_instance: *442 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -64376,9 +64575,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *441 + '403': *443 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64396,9 +64595,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *344 - - *345 - - *442 + - *346 + - *347 + - *444 requestBody: required: true content: @@ -64413,8 +64612,8 @@ paths: enum: - open - dismissed - dismissed_reason: *436 - dismissed_comment: *437 + dismissed_reason: *438 + dismissed_comment: *439 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -64442,7 +64641,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *445 examples: default: value: @@ -64518,14 +64717,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &447 + '403': &449 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64545,15 +64744,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *344 - - *345 - - *442 + - *346 + - *347 + - *444 responses: '200': description: Response content: application/json: - schema: &444 + schema: &446 type: object properties: status: @@ -64579,13 +64778,13 @@ paths: - description - started_at examples: - default: &445 + default: &447 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &446 + '400': &448 description: Bad Request content: application/json: @@ -64596,9 +64795,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *441 + '403': *443 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64621,29 +64820,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *344 - - *345 - - *442 + - *346 + - *347 + - *444 responses: '200': description: OK content: application/json: - schema: *444 + schema: *446 examples: - default: *445 + default: *447 '202': description: Accepted content: application/json: - schema: *444 + schema: *446 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *446 + '400': *448 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -64653,7 +64852,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64675,9 +64874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *344 - - *345 - - *442 + - *346 + - *347 + - *444 requestBody: required: false content: @@ -64722,12 +64921,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *446 - '403': *447 + '400': *448 + '403': *449 '404': *6 '422': description: Unprocessable Entity - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64747,13 +64946,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *344 - - *345 - - *442 + - *346 + - *347 + - *444 - *19 - *17 - - *448 - - *449 + - *450 + - *451 responses: '200': description: Response @@ -64764,10 +64963,10 @@ paths: items: type: object properties: - ref: *432 - analysis_key: *450 - environment: *451 - category: *452 + ref: *434 + analysis_key: *452 + environment: *453 + category: *454 state: type: string description: State of a code scanning alert instance. @@ -64782,7 +64981,7 @@ paths: properties: text: type: string - location: *453 + location: *455 html_url: type: string classifications: @@ -64790,7 +64989,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *454 + items: *456 examples: default: value: @@ -64827,9 +65026,9 @@ paths: end_column: 50 classifications: - source - '403': *441 + '403': *443 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64861,25 +65060,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *344 - - *345 - - *430 - - *431 + - *346 + - *347 + - *432 + - *433 - *19 - *17 - - *449 + - *451 - name: ref in: query description: The Git reference for the analyses 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`. required: false - schema: *432 + schema: *434 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &455 + schema: &457 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -64900,23 +65099,23 @@ paths: application/json: schema: type: array - items: &456 + items: &458 type: object properties: - ref: *432 - commit_sha: &464 + ref: *434 + commit_sha: &466 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *450 + analysis_key: *452 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *452 + category: *454 error: type: string example: error reading field xyz @@ -64940,8 +65139,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *455 - tool: *439 + sarif_id: *457 + tool: *441 deletable: type: boolean warning: @@ -65002,9 +65201,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *441 + '403': *443 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65038,8 +65237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -65052,7 +65251,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *458 examples: response: summary: application/json response @@ -65106,14 +65305,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *441 + '403': *443 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65193,8 +65392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -65247,9 +65446,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *447 + '403': *449 '404': *6 - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65269,8 +65468,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -65278,7 +65477,7 @@ paths: application/json: schema: type: array - items: &457 + items: &459 title: CodeQL Database description: A CodeQL database. type: object @@ -65389,9 +65588,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *441 + '403': *443 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65418,8 +65617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - name: language in: path description: The language of the CodeQL database. @@ -65431,7 +65630,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *459 examples: default: value: @@ -65463,11 +65662,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &495 + '302': &497 description: Found - '403': *441 + '403': *443 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65487,8 +65686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *344 - - *345 + - *346 + - *347 - name: language in: path description: The language of the CodeQL database. @@ -65498,9 +65697,9 @@ paths: responses: '204': description: Response - '403': *447 + '403': *449 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65526,8 +65725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -65536,7 +65735,7 @@ paths: type: object additionalProperties: false properties: - language: &458 + language: &460 type: string description: The language targeted by the CodeQL query enum: @@ -65616,7 +65815,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &462 + schema: &464 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -65626,7 +65825,7 @@ paths: description: The ID of the variant analysis. controller_repo: *67 actor: *4 - query_language: *458 + query_language: *460 query_pack_url: type: string description: The download url for the query pack. @@ -65673,7 +65872,7 @@ paths: items: type: object properties: - repository: &459 + repository: &461 title: Repository Identifier description: Repository Identifier type: object @@ -65709,7 +65908,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &463 + analysis_status: &465 type: string description: The new status of the CodeQL variant analysis repository task. @@ -65741,7 +65940,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &460 + access_mismatch_repos: &462 type: object properties: repository_count: @@ -65755,7 +65954,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *459 + items: *461 required: - repository_count - repositories @@ -65777,8 +65976,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *460 - over_limit_repos: *460 + no_codeql_db_repos: *462 + over_limit_repos: *462 required: - access_mismatch_repos - not_found_repos @@ -65794,7 +65993,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &461 + value: &463 summary: Default response value: id: 1 @@ -65940,17 +66139,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *461 + value: *463 repository_lists: summary: Response for a successful variant analysis submission - value: *461 + value: *463 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65971,8 +66170,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *344 - - *345 + - *346 + - *347 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -65984,11 +66183,11 @@ paths: description: Response content: application/json: - schema: *462 + schema: *464 examples: - default: *461 + default: *463 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66009,7 +66208,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *344 + - *346 - name: repo in: path description: The name of the controller repository. @@ -66044,7 +66243,7 @@ paths: type: object properties: repository: *67 - analysis_status: *463 + analysis_status: *465 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -66148,7 +66347,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66169,8 +66368,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -66272,9 +66471,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *441 + '403': *443 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66293,8 +66492,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -66361,7 +66560,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -66386,7 +66585,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *447 + '403': *449 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -66400,7 +66599,7 @@ paths: content: application/json: schema: *3 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66457,8 +66656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -66466,7 +66665,7 @@ paths: schema: type: object properties: - commit_sha: *464 + commit_sha: *466 ref: type: string description: |- @@ -66524,7 +66723,7 @@ paths: schema: type: object properties: - id: *455 + id: *457 url: type: string description: The REST API URL for checking the status of the upload. @@ -66538,11 +66737,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *447 + '403': *449 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -66561,8 +66760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *344 - - *345 + - *346 + - *347 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -66608,10 +66807,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *441 + '403': *443 '404': description: Not Found if the sarif id does not match any upload - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -66633,8 +66832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -66715,8 +66914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *344 - - *345 + - *346 + - *347 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -66836,8 +67035,8 @@ paths: parameters: - *17 - *19 - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -66853,7 +67052,7 @@ paths: type: integer codespaces: type: array - items: *248 + items: *250 examples: default: value: @@ -67151,8 +67350,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -67215,22 +67414,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67254,8 +67453,8 @@ paths: parameters: - *17 - *19 - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -67319,8 +67518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -67355,14 +67554,14 @@ paths: type: integer machines: type: array - items: &691 + items: &693 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *466 - required: *467 + properties: *468 + required: *469 examples: - default: &692 + default: &694 value: total_count: 2 machines: @@ -67402,8 +67601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *344 - - *345 + - *346 + - *347 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -67487,8 +67686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *344 - - *345 + - *346 + - *347 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -67533,7 +67732,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67554,8 +67753,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -67573,7 +67772,7 @@ paths: type: integer secrets: type: array - items: &471 + items: &473 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -67593,9 +67792,9 @@ paths: - created_at - updated_at examples: - default: *468 + default: *470 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67616,16 +67815,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *469 + schema: *471 examples: - default: *470 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67645,17 +67844,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 responses: '200': description: Response content: application/json: - schema: *471 + schema: *473 examples: - default: *472 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67675,9 +67874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 requestBody: required: true content: @@ -67705,7 +67904,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -67729,9 +67928,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 responses: '204': description: Response @@ -67759,8 +67958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *344 - - *345 + - *346 + - *347 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -67802,7 +68001,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &473 + properties: &475 login: type: string example: octocat @@ -67895,7 +68094,7 @@ paths: user_view_type: type: string example: public - required: &474 + required: &476 - avatar_url - events_url - followers_url @@ -67944,7 +68143,7 @@ paths: admin: false role_name: write headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -67969,9 +68168,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *344 - - *345 - - *72 + - *346 + - *347 + - *74 responses: '204': description: Response if user is a collaborator @@ -68017,9 +68216,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *344 - - *345 - - *72 + - *346 + - *347 + - *74 requestBody: required: false content: @@ -68045,7 +68244,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &546 + schema: &548 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -68056,7 +68255,7 @@ paths: example: 42 type: integer format: int64 - repository: *159 + repository: *161 invitee: title: Simple User description: A GitHub user. @@ -68234,7 +68433,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *128 + schema: *130 '403': *29 x-github: triggersNotification: true @@ -68274,9 +68473,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *344 - - *345 - - *72 + - *346 + - *347 + - *74 responses: '204': description: No Content when collaborator was removed from the repository. @@ -68307,9 +68506,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *344 - - *345 - - *72 + - *346 + - *347 + - *74 responses: '200': description: if user has admin permissions @@ -68329,8 +68528,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *473 - required: *474 + properties: *475 + required: *476 nullable: true required: - permission @@ -68385,8 +68584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -68396,7 +68595,7 @@ paths: application/json: schema: type: array - items: &475 + items: &477 title: Commit Comment description: Commit Comment type: object @@ -68437,8 +68636,8 @@ paths: updated_at: type: string format: date-time - author_association: *83 - reactions: *84 + author_association: *85 + reactions: *86 required: - url - html_url @@ -68454,7 +68653,7 @@ paths: - created_at - updated_at examples: - default: &480 + default: &482 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68488,7 +68687,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68513,17 +68712,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 responses: '200': description: Response content: application/json: - schema: *475 + schema: *477 examples: - default: &481 + default: &483 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68580,9 +68779,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 requestBody: required: true content: @@ -68604,7 +68803,7 @@ paths: description: Response content: application/json: - schema: *475 + schema: *477 examples: default: value: @@ -68655,9 +68854,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 responses: '204': description: Response @@ -68678,9 +68877,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -68706,7 +68905,7 @@ paths: application/json: schema: type: array - items: &476 + items: &478 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -68749,7 +68948,7 @@ paths: - content - created_at examples: - default: &550 + default: &552 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -68775,7 +68974,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -68794,9 +68993,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 requestBody: required: true content: @@ -68828,9 +69027,9 @@ paths: description: Reaction exists content: application/json: - schema: *476 + schema: *478 examples: - default: &477 + default: &479 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -68859,9 +69058,9 @@ paths: description: Reaction created content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '422': *15 x-github: githubCloudOnly: false @@ -68883,10 +69082,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *344 - - *345 - - *102 - - &551 + - *346 + - *347 + - *104 + - &553 name: reaction_id description: The unique identifier of the reaction. in: path @@ -68941,8 +69140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *344 - - *345 + - *346 + - *347 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -68998,9 +69197,9 @@ paths: application/json: schema: type: array - items: *478 + items: *480 examples: - default: &603 + default: &605 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69070,7 +69269,7 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *68 + Link: *70 '500': *55 '400': *14 '404': *6 @@ -69094,9 +69293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *344 - - *345 - - &479 + - *346 + - *347 + - &481 name: commit_sha description: The SHA of the commit. in: path @@ -69168,9 +69367,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *344 - - *345 - - *479 + - *346 + - *347 + - *481 - *17 - *19 responses: @@ -69180,11 +69379,11 @@ paths: application/json: schema: type: array - items: *475 + items: *477 examples: - default: *480 + default: *482 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69210,9 +69409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *344 - - *345 - - *479 + - *346 + - *347 + - *481 requestBody: required: true content: @@ -69247,9 +69446,9 @@ paths: description: Response content: application/json: - schema: *475 + schema: *477 examples: - default: *481 + default: *483 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69277,9 +69476,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *344 - - *345 - - *479 + - *346 + - *347 + - *481 - *17 - *19 responses: @@ -69289,9 +69488,9 @@ paths: application/json: schema: type: array - items: *482 + items: *484 examples: - default: &595 + default: &597 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -69770,7 +69969,7 @@ paths: auto_merge: draft: false headers: - Link: *68 + Link: *70 '409': *54 x-github: githubCloudOnly: false @@ -69828,11 +70027,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *344 - - *345 + - *346 + - *347 - *19 - *17 - - &483 + - &485 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -69847,9 +70046,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *480 examples: - default: &582 + default: &584 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69937,7 +70136,7 @@ paths: schema: type: string examples: - default: &492 + default: &494 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -69950,7 +70149,7 @@ paths: schema: type: string examples: - default: &493 + default: &495 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -69977,7 +70176,7 @@ paths: '422': *15 '404': *6 '500': *55 - '503': *120 + '503': *122 '409': *54 x-github: githubCloudOnly: false @@ -70003,11 +70202,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *344 - - *345 - - *483 - - *484 + - *346 + - *347 - *485 + - *486 + - *487 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -70041,11 +70240,11 @@ paths: type: integer check_runs: type: array - items: *422 + items: *424 examples: - default: *486 + default: *488 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70068,9 +70267,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *344 - - *345 - - *483 + - *346 + - *347 + - *485 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -70078,7 +70277,7 @@ paths: schema: type: integer example: 1 - - *484 + - *486 - *17 - *19 responses: @@ -70096,7 +70295,7 @@ paths: type: integer check_suites: type: array - items: *427 + items: *429 examples: default: value: @@ -70271,7 +70470,7 @@ paths: latest_check_runs_count: 1 check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70296,9 +70495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *344 - - *345 - - *483 + - *346 + - *347 + - *485 - *17 - *19 responses: @@ -70365,7 +70564,7 @@ paths: type: string total_count: type: integer - repository: *159 + repository: *161 commit_url: type: string format: uri @@ -70496,9 +70695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *344 - - *345 - - *483 + - *346 + - *347 + - *485 - *17 - *19 responses: @@ -70508,7 +70707,7 @@ paths: application/json: schema: type: array - items: &671 + items: &673 title: Status description: The status of a commit. type: object @@ -70588,8 +70787,8 @@ paths: type: User site_admin: false headers: - Link: *68 - '301': *348 + Link: *70 + '301': *350 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70617,8 +70816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -70647,20 +70846,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *487 - required: *488 + properties: *489 + required: *490 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &489 + properties: &491 url: type: string format: uri html_url: type: string format: uri - required: &490 + required: &492 - url - html_url nullable: true @@ -70668,32 +70867,32 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true contributing: title: Community Health File type: object - properties: *489 - required: *490 + properties: *491 + required: *492 nullable: true readme: title: Community Health File type: object - properties: *489 - required: *490 + properties: *491 + required: *492 nullable: true issue_template: title: Community Health File type: object - properties: *489 - required: *490 + properties: *491 + required: *492 nullable: true pull_request_template: title: Community Health File type: object - properties: *489 - required: *490 + properties: *491 + required: *492 nullable: true required: - code_of_conduct @@ -70820,8 +71019,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *344 - - *345 + - *346 + - *347 - *19 - *17 - name: basehead @@ -70864,8 +71063,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *478 - merge_base_commit: *478 + base_commit: *480 + merge_base_commit: *480 status: type: string enum: @@ -70885,10 +71084,10 @@ paths: example: 6 commits: type: array - items: *478 + items: *480 files: type: array - items: *491 + items: *493 required: - url - html_url @@ -71134,15 +71333,15 @@ paths: schema: type: string examples: - default: *492 + default: *494 application/vnd.github.patch: schema: type: string examples: - default: *493 + default: *495 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71184,8 +71383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *344 - - *345 + - *346 + - *347 - name: path description: path parameter in: path @@ -71345,7 +71544,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &494 + response-if-content-is-a-file-github-object: &496 summary: Response if content is a file value: type: file @@ -71477,7 +71676,7 @@ paths: - size - type - url - - &608 + - &610 title: Content File description: Content File type: object @@ -71678,7 +71877,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *494 + response-if-content-is-a-file: *496 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -71747,7 +71946,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *495 + '302': *497 '304': *37 x-github: githubCloudOnly: false @@ -71800,8 +71999,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *344 - - *345 + - *346 + - *347 - name: path description: path parameter in: path @@ -71894,7 +72093,7 @@ paths: description: Response content: application/json: - schema: &496 + schema: &498 title: File Commit description: File Commit type: object @@ -72046,7 +72245,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *498 examples: example-for-creating-a-file: value: @@ -72100,7 +72299,7 @@ paths: schema: oneOf: - *3 - - &528 + - &530 description: Repository rule violation was detected type: object properties: @@ -72121,7 +72320,7 @@ paths: items: type: object properties: - placeholder_id: &663 + placeholder_id: &665 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -72153,8 +72352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *344 - - *345 + - *346 + - *347 - name: path description: path parameter in: path @@ -72215,7 +72414,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *498 examples: default: value: @@ -72250,7 +72449,7 @@ paths: '422': *15 '404': *6 '409': *54 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72270,8 +72469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *344 - - *345 + - *346 + - *347 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -72371,7 +72570,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *68 + Link: *70 '204': description: Response if repository is empty '403': *29 @@ -72394,24 +72593,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *344 - - *345 - - *197 - - *198 + - *346 + - *347 - *199 - *200 - *201 + - *202 + - *203 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *202 - - *497 - - *203 - *204 + - *499 - *205 + - *206 + - *207 - *62 - *47 - *48 @@ -72423,11 +72622,11 @@ paths: application/json: schema: type: array - items: &501 + items: &503 type: object description: A Dependabot alert. properties: - number: *177 + number: *179 state: type: string description: The state of the Dependabot alert. @@ -72470,13 +72669,13 @@ paths: - direct - transitive - inconclusive - security_advisory: *498 + security_advisory: *500 security_vulnerability: *66 - url: *180 - html_url: *181 - created_at: *178 - updated_at: *179 - dismissed_at: *183 + url: *182 + html_url: *183 + created_at: *180 + updated_at: *181 + dismissed_at: *185 dismissed_by: title: Simple User description: A GitHub user. @@ -72500,9 +72699,9 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *182 - auto_dismissed_at: *499 - dismissal_request: *500 + fixed_at: *184 + auto_dismissed_at: *501 + dismissal_request: *502 assignees: type: array description: The users assigned to this alert. @@ -72757,9 +72956,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *344 - - *345 - - &502 + - *346 + - *347 + - &504 name: alert_number in: path description: |- @@ -72768,13 +72967,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *177 + schema: *179 responses: '200': description: Response content: application/json: - schema: *501 + schema: *503 examples: default: value: @@ -72906,9 +73105,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *344 - - *345 - - *502 + - *346 + - *347 + - *504 requestBody: required: true content: @@ -72964,7 +73163,7 @@ paths: description: Response content: application/json: - schema: *501 + schema: *503 examples: default: value: @@ -73094,8 +73293,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -73113,7 +73312,7 @@ paths: type: integer secrets: type: array - items: &505 + items: &507 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -73144,7 +73343,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73166,16 +73365,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *503 + schema: *505 examples: - default: *504 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73195,15 +73394,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 responses: '200': description: Response content: application/json: - schema: *505 + schema: *507 examples: default: value: @@ -73229,9 +73428,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 requestBody: required: true content: @@ -73259,7 +73458,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -73283,9 +73482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *344 - - *345 - - *167 + - *346 + - *347 + - *169 responses: '204': description: Response @@ -73307,8 +73506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *344 - - *345 + - *346 + - *347 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -73444,7 +73643,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *68 + Link: *70 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -73468,8 +73667,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -73685,7 +73884,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *68 + Link: *70 '404': *6 '403': *29 x-github: @@ -73707,8 +73906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - name: sbom_uuid in: path required: true @@ -73719,7 +73918,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *506 + Location: *508 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -73740,8 +73939,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '201': description: Response @@ -73779,8 +73978,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -73855,7 +74054,7 @@ paths: - version - url additionalProperties: false - metadata: &507 + metadata: &509 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -73888,7 +74087,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *507 + metadata: *509 resolved: type: object description: A collection of resolved package dependencies. @@ -73901,7 +74100,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *507 + metadata: *509 relationship: type: string description: A notation of whether a dependency is requested @@ -74030,8 +74229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *344 - - *345 + - *346 + - *347 - name: sha description: The SHA recorded at creation time. in: query @@ -74071,11 +74270,11 @@ paths: application/json: schema: type: array - items: *508 + items: *510 examples: - default: *509 + default: *511 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74139,8 +74338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -74221,7 +74420,7 @@ paths: description: Response content: application/json: - schema: *508 + schema: *510 examples: simple-example: summary: Simple example @@ -74294,9 +74493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *344 - - *345 - - &510 + - *346 + - *347 + - &512 name: deployment_id description: deployment_id parameter in: path @@ -74308,7 +74507,7 @@ paths: description: Response content: application/json: - schema: *508 + schema: *510 examples: default: value: @@ -74373,9 +74572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *344 - - *345 - - *510 + - *346 + - *347 + - *512 responses: '204': description: Response @@ -74397,9 +74596,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *344 - - *345 - - *510 + - *346 + - *347 + - *512 - *17 - *19 responses: @@ -74409,7 +74608,7 @@ paths: application/json: schema: type: array - items: &511 + items: &513 title: Deployment Status description: The status of a deployment. type: object @@ -74500,8 +74699,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -74550,7 +74749,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -74570,9 +74769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *344 - - *345 - - *510 + - *346 + - *347 + - *512 requestBody: required: true content: @@ -74647,9 +74846,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *513 examples: - default: &512 + default: &514 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -74705,9 +74904,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *344 - - *345 - - *510 + - *346 + - *347 + - *512 - name: status_id in: path required: true @@ -74718,9 +74917,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *513 examples: - default: *512 + default: *514 '404': *6 x-github: githubCloudOnly: false @@ -74745,8 +74944,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -74803,8 +75002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -74821,7 +75020,7 @@ paths: type: integer environments: type: array - items: &514 + items: &516 title: Environment description: Details of a deployment environment type: object @@ -74873,7 +75072,7 @@ paths: type: type: string example: wait_timer - wait_timer: &516 + wait_timer: &518 type: integer example: 30 description: The amount of time to delay a job after @@ -74910,11 +75109,11 @@ paths: items: type: object properties: - type: *513 + type: *515 reviewer: anyOf: - *4 - - *195 + - *197 required: - id - node_id @@ -74934,7 +75133,7 @@ paths: - id - node_id - type - deployment_branch_policy: &517 + deployment_branch_policy: &519 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -75050,9 +75249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *344 - - *345 - - &515 + - *346 + - *347 + - &517 name: environment_name in: path required: true @@ -75065,9 +75264,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *516 examples: - default: &518 + default: &520 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -75151,9 +75350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *344 - - *345 - - *515 + - *346 + - *347 + - *517 requestBody: required: false content: @@ -75162,7 +75361,7 @@ paths: type: object nullable: true properties: - wait_timer: *516 + wait_timer: *518 prevent_self_review: type: boolean example: false @@ -75179,13 +75378,13 @@ paths: items: type: object properties: - type: *513 + type: *515 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *517 + deployment_branch_policy: *519 additionalProperties: false examples: default: @@ -75205,9 +75404,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *516 examples: - default: *518 + default: *520 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -75231,9 +75430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *344 - - *345 - - *515 + - *346 + - *347 + - *517 responses: '204': description: Default response @@ -75258,9 +75457,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *344 - - *345 - - *515 + - *346 + - *347 + - *517 - *17 - *19 responses: @@ -75278,7 +75477,7 @@ paths: example: 2 branch_policies: type: array - items: &519 + items: &521 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -75335,9 +75534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *344 - - *345 - - *515 + - *346 + - *347 + - *517 requestBody: required: true content: @@ -75383,9 +75582,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *521 examples: - example-wildcard: &520 + example-wildcard: &522 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -75427,10 +75626,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *344 - - *345 - - *515 - - &521 + - *346 + - *347 + - *517 + - &523 name: branch_policy_id in: path required: true @@ -75442,9 +75641,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *521 examples: - default: *520 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75463,10 +75662,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *344 - - *345 - - *515 - - *521 + - *346 + - *347 + - *517 + - *523 requestBody: required: true content: @@ -75494,9 +75693,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *521 examples: - default: *520 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75515,10 +75714,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *344 - - *345 - - *515 - - *521 + - *346 + - *347 + - *517 + - *523 responses: '204': description: Response @@ -75543,9 +75742,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *515 - - *345 - - *344 + - *517 + - *347 + - *346 responses: '200': description: List of deployment protection rules @@ -75561,7 +75760,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &522 + items: &524 title: Deployment protection rule description: Deployment protection rule type: object @@ -75580,7 +75779,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &523 + app: &525 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -75679,9 +75878,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *515 - - *345 - - *344 + - *517 + - *347 + - *346 requestBody: content: application/json: @@ -75702,9 +75901,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *522 + schema: *524 examples: - default: &524 + default: &526 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -75739,9 +75938,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *515 - - *345 - - *344 + - *517 + - *347 + - *346 - *19 - *17 responses: @@ -75760,7 +75959,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *523 + items: *525 examples: default: value: @@ -75795,10 +75994,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *344 - - *345 - - *515 - - &525 + - *346 + - *347 + - *517 + - &527 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -75810,9 +76009,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *524 examples: - default: *524 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75833,10 +76032,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *515 - - *345 - - *344 - - *525 + - *517 + - *347 + - *346 + - *527 responses: '204': description: Response @@ -75862,9 +76061,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *344 - - *345 - - *515 + - *346 + - *347 + - *517 - *17 - *19 responses: @@ -75882,11 +76081,11 @@ paths: type: integer secrets: type: array - items: *389 + items: *391 examples: - default: *390 + default: *392 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75909,17 +76108,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *344 - - *345 - - *515 + - *346 + - *347 + - *517 responses: '200': description: Response content: application/json: - schema: *391 + schema: *393 examples: - default: *392 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75941,18 +76140,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *344 - - *345 - - *515 - - *167 + - *346 + - *347 + - *517 + - *169 responses: '200': description: Response content: application/json: - schema: *389 + schema: *391 examples: - default: *526 + default: *528 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75974,10 +76173,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *344 - - *345 - - *515 - - *167 + - *346 + - *347 + - *517 + - *169 requestBody: required: true content: @@ -76008,7 +76207,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -76034,10 +76233,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *344 - - *345 - - *515 - - *167 + - *346 + - *347 + - *517 + - *169 responses: '204': description: Default response @@ -76062,10 +76261,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *344 - - *345 - - *515 - - *360 + - *346 + - *347 + - *517 + - *362 - *19 responses: '200': @@ -76082,11 +76281,11 @@ paths: type: integer variables: type: array - items: *393 + items: *395 examples: - default: *394 + default: *396 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76107,9 +76306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *344 - - *345 - - *515 + - *346 + - *347 + - *517 requestBody: required: true content: @@ -76136,7 +76335,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -76161,18 +76360,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *344 - - *345 - - *515 - - *170 + - *346 + - *347 + - *517 + - *172 responses: '200': description: Response content: application/json: - schema: *393 + schema: *395 examples: - default: *527 + default: *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76193,10 +76392,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *344 - - *345 - - *170 - - *515 + - *346 + - *347 + - *172 + - *517 requestBody: required: true content: @@ -76238,10 +76437,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *344 - - *345 - - *170 - - *515 + - *346 + - *347 + - *172 + - *517 responses: '204': description: Response @@ -76263,8 +76462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -76274,7 +76473,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: 200-response: value: @@ -76332,8 +76531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *344 - - *345 + - *346 + - *347 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -76355,7 +76554,7 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: default: value: @@ -76468,7 +76667,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *68 + Link: *70 '400': *14 x-github: githubCloudOnly: false @@ -76492,8 +76691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: false content: @@ -76525,9 +76724,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *349 + default: *351 '400': *14 '422': *15 '403': *29 @@ -76548,8 +76747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -76608,8 +76807,8 @@ paths: application/json: schema: oneOf: - - *128 - - *528 + - *130 + - *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76634,8 +76833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *344 - - *345 + - *346 + - *347 - name: file_sha in: path required: true @@ -76734,8 +76933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -76844,7 +77043,7 @@ paths: description: Response content: application/json: - schema: &529 + schema: &531 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -77058,15 +77257,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *344 - - *345 - - *479 + - *346 + - *347 + - *481 responses: '200': description: Response content: application/json: - schema: *529 + schema: *531 examples: default: value: @@ -77122,9 +77321,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *344 - - *345 - - &530 + - *346 + - *347 + - &532 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -77141,7 +77340,7 @@ paths: application/json: schema: type: array - items: &531 + items: &533 title: Git Reference description: Git references within a repository type: object @@ -77194,7 +77393,7 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *68 + Link: *70 '409': *54 x-github: githubCloudOnly: false @@ -77216,17 +77415,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *344 - - *345 - - *530 + - *346 + - *347 + - *532 responses: '200': description: Response content: application/json: - schema: *531 + schema: *533 examples: - default: &532 + default: &534 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -77255,8 +77454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -77285,9 +77484,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *533 examples: - default: *532 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -77313,9 +77512,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *344 - - *345 - - *530 + - *346 + - *347 + - *532 requestBody: required: true content: @@ -77344,9 +77543,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *533 examples: - default: *532 + default: *534 '422': *15 '409': *54 x-github: @@ -77364,9 +77563,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *344 - - *345 - - *530 + - *346 + - *347 + - *532 responses: '204': description: Response @@ -77421,8 +77620,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -77489,7 +77688,7 @@ paths: description: Response content: application/json: - schema: &534 + schema: &536 title: Git Tag description: Metadata for a Git tag type: object @@ -77540,7 +77739,7 @@ paths: - sha - type - url - verification: *533 + verification: *535 required: - sha - url @@ -77550,7 +77749,7 @@ paths: - tag - message examples: - default: &535 + default: &537 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -77623,8 +77822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *344 - - *345 + - *346 + - *347 - name: tag_sha in: path required: true @@ -77635,9 +77834,9 @@ paths: description: Response content: application/json: - schema: *534 + schema: *536 examples: - default: *535 + default: *537 '404': *6 '409': *54 x-github: @@ -77661,8 +77860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -77735,7 +77934,7 @@ paths: description: Response content: application/json: - schema: &536 + schema: &538 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -77831,8 +78030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *344 - - *345 + - *346 + - *347 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -77855,7 +78054,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *538 examples: default-response: summary: Default response @@ -77914,8 +78113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -77925,7 +78124,7 @@ paths: application/json: schema: type: array - items: &537 + items: &539 title: Webhook description: Webhooks for repositories. type: object @@ -77979,7 +78178,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &785 + last_response: &787 title: Hook Response type: object properties: @@ -78034,7 +78233,7 @@ paths: status: unused message: headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -78053,8 +78252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: false content: @@ -78106,9 +78305,9 @@ paths: description: Response content: application/json: - schema: *537 + schema: *539 examples: - default: &538 + default: &540 value: type: Repository id: 12345678 @@ -78156,17 +78355,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 responses: '200': description: Response content: application/json: - schema: *537 + schema: *539 examples: - default: *538 + default: *540 '404': *6 x-github: githubCloudOnly: false @@ -78186,9 +78385,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 requestBody: required: true content: @@ -78233,9 +78432,9 @@ paths: description: Response content: application/json: - schema: *537 + schema: *539 examples: - default: *538 + default: *540 '422': *15 '404': *6 x-github: @@ -78256,9 +78455,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 responses: '204': description: Response @@ -78282,9 +78481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 responses: '200': description: Response @@ -78311,9 +78510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 requestBody: required: false content: @@ -78357,12 +78556,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *344 - - *345 - - *216 - - *17 - - *217 + - *346 + - *347 - *218 + - *17 + - *219 + - *220 responses: '200': description: Response @@ -78370,9 +78569,9 @@ paths: application/json: schema: type: array - items: *219 + items: *221 examples: - default: *220 + default: *222 '400': *14 '422': *15 x-github: @@ -78391,18 +78590,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 - *16 responses: '200': description: Response content: application/json: - schema: *221 + schema: *223 examples: - default: *222 + default: *224 '400': *14 '422': *15 x-github: @@ -78421,9 +78620,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 - *16 responses: '202': *39 @@ -78446,9 +78645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 responses: '204': description: Response @@ -78473,9 +78672,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *344 - - *345 - - *216 + - *346 + - *347 + - *218 responses: '204': description: Response @@ -78498,8 +78697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response if immutable releases are enabled @@ -78545,8 +78744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': *61 '409': *54 @@ -78566,8 +78765,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': *61 '409': *54 @@ -78624,14 +78823,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: &539 + schema: &541 title: Import description: A repository import from an external source. type: object @@ -78730,7 +78929,7 @@ paths: - html_url - authors_url examples: - default: &542 + default: &544 value: vcs: subversion use_lfs: true @@ -78746,7 +78945,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &540 + '503': &542 description: Unavailable due to service under maintenance. content: application/json: @@ -78775,8 +78974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -78824,7 +79023,7 @@ paths: description: Response content: application/json: - schema: *539 + schema: *541 examples: default: value: @@ -78849,7 +79048,7 @@ paths: type: string '422': *15 '404': *6 - '503': *540 + '503': *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78877,8 +79076,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: false content: @@ -78927,7 +79126,7 @@ paths: description: Response content: application/json: - schema: *539 + schema: *541 examples: example-1: summary: Example 1 @@ -78975,7 +79174,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *540 + '503': *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78998,12 +79197,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response - '503': *540 + '503': *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79029,9 +79228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *344 - - *345 - - &713 + - *346 + - *347 + - &715 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -79045,7 +79244,7 @@ paths: application/json: schema: type: array - items: &541 + items: &543 title: Porter Author description: Porter Author type: object @@ -79099,7 +79298,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *540 + '503': *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79124,8 +79323,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *344 - - *345 + - *346 + - *347 - name: author_id in: path required: true @@ -79155,7 +79354,7 @@ paths: description: Response content: application/json: - schema: *541 + schema: *543 examples: default: value: @@ -79168,7 +79367,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *540 + '503': *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79192,8 +79391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -79234,7 +79433,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *540 + '503': *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79262,8 +79461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -79290,11 +79489,11 @@ paths: description: Response content: application/json: - schema: *539 + schema: *541 examples: - default: *542 + default: *544 '422': *15 - '503': *540 + '503': *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79317,8 +79516,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -79326,8 +79525,8 @@ paths: application/json: schema: *22 examples: - default: *543 - '301': *348 + default: *545 + '301': *350 '404': *6 x-github: githubCloudOnly: false @@ -79347,8 +79546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -79356,12 +79555,12 @@ paths: application/json: schema: anyOf: - - *235 + - *237 - type: object properties: {} additionalProperties: false examples: - default: &545 + default: &547 value: limit: collaborators_only origin: repository @@ -79386,13 +79585,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: application/json: - schema: *544 + schema: *546 examples: default: summary: Example request body @@ -79404,9 +79603,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *237 examples: - default: *545 + default: *547 '409': description: Response x-github: @@ -79428,8 +79627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -79452,8 +79651,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -79463,9 +79662,9 @@ paths: application/json: schema: type: array - items: *546 + items: *548 examples: - default: &706 + default: &708 value: - id: 1 repository: @@ -79579,7 +79778,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79596,9 +79795,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *344 - - *345 - - *239 + - *346 + - *347 + - *241 requestBody: required: false content: @@ -79627,7 +79826,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: default: value: @@ -79758,9 +79957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *344 - - *345 - - *239 + - *346 + - *347 + - *241 responses: '204': description: Response @@ -79791,8 +79990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *344 - - *345 + - *346 + - *347 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -79840,7 +80039,7 @@ paths: required: false schema: type: string - - *246 + - *248 - name: sort description: What to sort results by. in: query @@ -79853,7 +80052,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -79863,9 +80062,9 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: &559 + default: &561 value: - id: 1 node_id: MDU6SXNzdWUx @@ -80013,8 +80212,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *68 - '301': *348 + Link: *70 + '301': *350 '422': *15 '404': *6 x-github: @@ -80043,8 +80242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -80126,9 +80325,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: &556 + default: &558 value: id: 1 node_id: MDU6SXNzdWUx @@ -80289,9 +80488,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *120 + '503': *122 '404': *6 - '410': *547 + '410': *549 x-github: triggersNotification: true githubCloudOnly: false @@ -80329,9 +80528,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *344 - - *345 - - *110 + - *346 + - *347 + - *112 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -80341,7 +80540,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -80351,9 +80550,9 @@ paths: application/json: schema: type: array - items: *548 + items: *550 examples: - default: &558 + default: &560 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -80384,7 +80583,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 '422': *15 '404': *6 x-github: @@ -80411,17 +80610,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 responses: '200': description: Response content: application/json: - schema: *548 + schema: *550 examples: - default: &549 + default: &551 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -80476,9 +80675,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 requestBody: required: true content: @@ -80500,9 +80699,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: - default: *549 + default: *551 '422': *15 x-github: githubCloudOnly: false @@ -80520,9 +80719,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 responses: '204': description: Response @@ -80550,15 +80749,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 responses: '200': description: Response content: application/json: - schema: *548 + schema: *550 examples: default: value: @@ -80614,7 +80813,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *547 + '410': *549 '422': *15 x-github: githubCloudOnly: false @@ -80631,17 +80830,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 responses: '204': description: Response '401': *25 '403': *29 '404': *6 - '410': *547 - '503': *120 + '410': *549 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80658,9 +80857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -80686,11 +80885,11 @@ paths: application/json: schema: type: array - items: *476 + items: *478 examples: - default: *550 + default: *552 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -80709,9 +80908,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 requestBody: required: true content: @@ -80743,16 +80942,16 @@ paths: description: Reaction exists content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '201': description: Reaction created content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '422': *15 x-github: githubCloudOnly: false @@ -80774,10 +80973,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *344 - - *345 - - *102 - - *551 + - *346 + - *347 + - *104 + - *553 responses: '204': description: Response @@ -80797,8 +80996,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -80808,7 +81007,7 @@ paths: application/json: schema: type: array - items: &555 + items: &557 title: Issue Event description: Issue Event type: object @@ -80851,9 +81050,9 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *552 - required: *553 - x-github-breaking-changes: *554 + properties: *554 + required: *555 + x-github-breaking-changes: *556 nullable: true label: title: Issue Event Label @@ -80897,7 +81096,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *195 + requested_team: *197 dismissed_review: title: Issue Event Dismissed Review type: object @@ -80962,7 +81161,7 @@ paths: required: - from - to - author_association: *83 + author_association: *85 lock_reason: type: string nullable: true @@ -80975,8 +81174,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 required: - id - node_id @@ -81143,7 +81342,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -81161,8 +81360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *344 - - *345 + - *346 + - *347 - name: event_id in: path required: true @@ -81173,7 +81372,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *557 examples: default: value: @@ -81366,7 +81565,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *547 + '410': *549 '403': *29 x-github: githubCloudOnly: false @@ -81400,9 +81599,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *344 - - *345 - - &557 + - *346 + - *347 + - &559 name: issue_number description: The number that identifies the issue. in: path @@ -81414,11 +81613,11 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: default: summary: Issue - value: *556 + value: *558 pinned_comment: summary: Issue with pinned comment value: @@ -81623,9 +81822,9 @@ paths: - op: remove path: "/value/assignee" version: '2026-03-10' - '301': *348 + '301': *350 '404': *6 - '410': *547 + '410': *549 '304': *37 x-github: githubCloudOnly: false @@ -81650,9 +81849,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: false content: @@ -81776,15 +81975,15 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 + default: *558 '422': *15 - '503': *120 + '503': *122 '403': *29 - '301': *348 + '301': *350 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81812,9 +82011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: false content: @@ -81840,9 +82039,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81858,9 +82057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: content: application/json: @@ -81885,9 +82084,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81909,9 +82108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - name: assignee in: path required: true @@ -81951,10 +82150,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *344 - - *345 - - *557 - - *93 + - *346 + - *347 + - *559 + - *95 - *17 - *19 responses: @@ -81964,13 +82163,13 @@ paths: application/json: schema: type: array - items: *548 + items: *550 examples: - default: *558 + default: *560 headers: - Link: *68 + Link: *70 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81999,9 +82198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: true content: @@ -82023,16 +82222,16 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: - default: *549 + default: *551 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *547 + '410': *549 '422': *15 '404': *6 x-github: @@ -82060,9 +82259,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - *17 - *19 responses: @@ -82072,14 +82271,14 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *559 + default: *561 headers: - Link: *68 - '301': *348 + Link: *70 + '301': *350 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82107,9 +82306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: true content: @@ -82131,17 +82330,17 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 + default: *558 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *348 + '301': *350 '403': *29 - '410': *547 + '410': *549 '422': *15 '404': *6 x-github: @@ -82172,9 +82371,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -82186,15 +82385,15 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 - '301': *348 + default: *558 + '301': *350 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *547 + '410': *549 x-github: triggersNotification: true githubCloudOnly: false @@ -82220,9 +82419,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - *17 - *19 responses: @@ -82232,14 +82431,14 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *559 + default: *561 headers: - Link: *68 - '301': *348 + Link: *70 + '301': *350 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82256,9 +82455,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - *17 - *19 responses: @@ -82272,7 +82471,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &563 + - &565 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -82303,8 +82502,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 label: type: object properties: @@ -82326,7 +82525,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &564 + - &566 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -82357,8 +82556,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 label: type: object properties: @@ -82446,8 +82645,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 assigner: *4 required: @@ -82462,7 +82661,7 @@ paths: - performed_via_github_app - assignee - assigner - - &565 + - &567 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -82493,8 +82692,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 milestone: type: object properties: @@ -82513,7 +82712,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &568 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -82544,8 +82743,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 milestone: type: object properties: @@ -82564,7 +82763,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &569 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -82595,8 +82794,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 rename: type: object properties: @@ -82618,7 +82817,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &570 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -82649,10 +82848,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 review_requester: *4 - requested_team: *195 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -82665,7 +82864,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &569 + - &571 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -82696,10 +82895,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 review_requester: *4 - requested_team: *195 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -82712,7 +82911,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &570 + - &572 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -82743,8 +82942,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 dismissed_review: type: object properties: @@ -82772,7 +82971,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &571 + - &573 title: Locked Issue Event description: Locked Issue Event type: object @@ -82803,8 +83002,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 lock_reason: type: string example: '"off-topic"' @@ -82820,7 +83019,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &572 + - &574 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -82851,8 +83050,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -82886,7 +83085,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &573 + - &575 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -82917,8 +83116,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -82952,7 +83151,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &574 + - &576 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -82983,8 +83182,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 project_card: type: object properties: @@ -83018,7 +83217,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &575 + - &577 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -83108,8 +83307,8 @@ paths: name: label color: red headers: - Link: *68 - '410': *547 + Link: *70 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83126,9 +83325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - *17 - *19 responses: @@ -83138,9 +83337,9 @@ paths: application/json: schema: type: array - items: *560 + items: *562 examples: - default: &561 + default: &563 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -83163,10 +83362,10 @@ paths: data_type: date value: '2025-12-25' headers: - Link: *68 - '301': *348 + Link: *70 + '301': *350 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83195,9 +83394,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: true content: @@ -83261,14 +83460,14 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *560 + items: *562 examples: - default: *561 + default: *563 '400': *14 '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -83299,9 +83498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: true content: @@ -83366,14 +83565,14 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *560 + items: *562 examples: - default: *561 + default: *563 '400': *14 '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -83399,17 +83598,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *344 - - *345 - - *557 - - *242 + - *346 + - *347 + - *559 + - *244 responses: '204': description: Issue field value deleted successfully '403': *29 '404': *6 '422': *15 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -83427,9 +83626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - *17 - *19 responses: @@ -83439,9 +83638,9 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: &562 + default: &564 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83458,10 +83657,10 @@ paths: color: a2eeef default: false headers: - Link: *68 - '301': *348 + Link: *70 + '301': *350 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83477,9 +83676,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: false content: @@ -83522,12 +83721,12 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *562 - '301': *348 + default: *564 + '301': *350 '404': *6 - '410': *547 + '410': *549 '422': *15 x-github: githubCloudOnly: false @@ -83544,9 +83743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: false content: @@ -83606,12 +83805,12 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *562 - '301': *348 + default: *564 + '301': *350 '404': *6 - '410': *547 + '410': *549 '422': *15 x-github: githubCloudOnly: false @@ -83628,15 +83827,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 responses: '204': description: Response - '301': *348 + '301': *350 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83655,9 +83854,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - name: name in: path required: true @@ -83670,7 +83869,7 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: default: value: @@ -83681,9 +83880,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *348 + '301': *350 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83703,9 +83902,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: false content: @@ -83733,7 +83932,7 @@ paths: '204': description: Response '403': *29 - '410': *547 + '410': *549 '404': *6 '422': *15 x-github: @@ -83751,9 +83950,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 responses: '204': description: Response @@ -83783,20 +83982,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 responses: '200': description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 - '301': *348 + default: *558 + '301': *350 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83813,9 +84012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -83841,13 +84040,13 @@ paths: application/json: schema: type: array - items: *476 + items: *478 examples: - default: *550 + default: *552 headers: - Link: *68 + Link: *70 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83865,9 +84064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: true content: @@ -83899,16 +84098,16 @@ paths: description: Response content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '201': description: Response content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '422': *15 x-github: githubCloudOnly: false @@ -83930,10 +84129,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *344 - - *345 - - *557 - - *551 + - *346 + - *347 + - *559 + - *553 responses: '204': description: Response @@ -83962,9 +84161,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: true content: @@ -83986,9 +84185,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 + default: *558 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -84021,9 +84220,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - *17 - *19 responses: @@ -84033,13 +84232,13 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *559 + default: *561 headers: - Link: *68 + Link: *70 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84067,9 +84266,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: true content: @@ -84096,16 +84295,16 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 + default: *558 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *547 + '410': *549 '422': *15 '404': *6 x-github: @@ -84125,9 +84324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 requestBody: required: true content: @@ -84158,13 +84357,13 @@ paths: description: Response content: application/json: - schema: *86 + schema: *88 examples: - default: *556 + default: *558 '403': *29 '404': *6 '422': *7 - '503': *120 + '503': *122 x-github: triggersNotification: true githubCloudOnly: false @@ -84182,9 +84381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *344 - - *345 - - *557 + - *346 + - *347 + - *559 - *17 - *19 responses: @@ -84199,8 +84398,6 @@ paths: description: Timeline Event type: object anyOf: - - *563 - - *564 - *565 - *566 - *567 @@ -84212,6 +84409,8 @@ paths: - *573 - *574 - *575 + - *576 + - *577 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -84254,7 +84453,7 @@ paths: issue_url: type: string format: uri - author_association: *83 + author_association: *85 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -84264,16 +84463,16 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 - reactions: *84 + properties: *83 + required: *84 + reactions: *86 pin: title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *576 - required: *577 + properties: *578 + required: *579 nullable: true required: - event @@ -84305,7 +84504,7 @@ paths: properties: type: type: string - issue: *86 + issue: *88 required: - event - created_at @@ -84505,7 +84704,7 @@ paths: type: string body_text: type: string - author_association: *83 + author_association: *85 required: - event - id @@ -84528,7 +84727,7 @@ paths: type: string comments: type: array - items: &597 + items: &599 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -84623,7 +84822,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *83 + author_association: *85 _links: type: object properties: @@ -84707,7 +84906,7 @@ paths: enum: - line - file - reactions: *84 + reactions: *86 body_html: type: string example: '"

comment body

"' @@ -84743,7 +84942,7 @@ paths: type: string comments: type: array - items: *475 + items: *477 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -84774,8 +84973,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 required: - id @@ -84818,8 +85017,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 assignee: *4 required: - id @@ -84862,8 +85061,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 state_reason: type: string nullable: true @@ -85030,9 +85229,9 @@ paths: type: User site_admin: true headers: - Link: *68 + Link: *70 '404': *6 - '410': *547 + '410': *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85049,8 +85248,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -85060,7 +85259,7 @@ paths: application/json: schema: type: array - items: &578 + items: &580 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -85110,7 +85309,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85126,8 +85325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -85163,9 +85362,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *580 examples: - default: &579 + default: &581 value: id: 1 key: ssh-rsa AAA... @@ -85199,9 +85398,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *344 - - *345 - - &580 + - *346 + - *347 + - &582 name: key_id description: The unique identifier of the key. in: path @@ -85213,9 +85412,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *580 examples: - default: *579 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -85233,9 +85432,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *344 - - *345 - - *580 + - *346 + - *347 + - *582 responses: '204': description: Response @@ -85255,8 +85454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -85266,11 +85465,11 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *562 + default: *564 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -85289,8 +85488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -85326,9 +85525,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: - default: &581 + default: &583 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85360,8 +85559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *344 - - *345 + - *346 + - *347 - name: name in: path required: true @@ -85372,9 +85571,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: - default: *581 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -85391,8 +85590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *344 - - *345 + - *346 + - *347 - name: name in: path required: true @@ -85431,7 +85630,7 @@ paths: description: Response content: application/json: - schema: *85 + schema: *87 examples: default: value: @@ -85457,8 +85656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *344 - - *345 + - *346 + - *347 - name: name in: path required: true @@ -85484,8 +85683,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -85524,9 +85723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *344 - - *345 - - *448 + - *346 + - *347 + - *450 responses: '200': description: Response @@ -85588,8 +85787,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true required: - _links @@ -85671,8 +85870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -85737,8 +85936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -85772,9 +85971,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *478 + schema: *480 examples: - default: *582 + default: *584 '204': description: Response when already merged '404': @@ -85799,8 +85998,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *344 - - *345 + - *346 + - *347 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -85841,12 +86040,12 @@ paths: application/json: schema: type: array - items: &583 + items: &585 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *280 - required: *281 + properties: *282 + required: *283 examples: default: value: @@ -85885,7 +86084,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -85902,8 +86101,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -85943,9 +86142,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *585 examples: - default: &584 + default: &586 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -86004,9 +86203,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *344 - - *345 - - &585 + - *346 + - *347 + - &587 name: milestone_number description: The number that identifies the milestone. in: path @@ -86018,9 +86217,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 '404': *6 x-github: githubCloudOnly: false @@ -86037,9 +86236,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *344 - - *345 - - *585 + - *346 + - *347 + - *587 requestBody: required: false content: @@ -86077,9 +86276,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *585 examples: - default: *584 + default: *586 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86095,9 +86294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *344 - - *345 - - *585 + - *346 + - *347 + - *587 responses: '204': description: Response @@ -86118,9 +86317,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *344 - - *345 - - *585 + - *346 + - *347 + - *587 - *17 - *19 responses: @@ -86130,11 +86329,11 @@ paths: application/json: schema: type: array - items: *85 + items: *87 examples: - default: *562 + default: *564 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86151,12 +86350,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *344 - - *345 - - *586 - - *587 - - *93 + - *346 + - *347 - *588 + - *589 + - *95 + - *590 - *17 - *19 responses: @@ -86166,11 +86365,11 @@ paths: application/json: schema: type: array - items: *113 + items: *115 examples: - default: *589 + default: *591 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86192,8 +86391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: false content: @@ -86251,14 +86450,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: &590 + schema: &592 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -86383,7 +86582,7 @@ paths: - custom_404 - public examples: - default: &591 + default: &593 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -86424,8 +86623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -86479,9 +86678,9 @@ paths: description: Response content: application/json: - schema: *590 + schema: *592 examples: - default: *591 + default: *593 '422': *15 '409': *54 x-github: @@ -86504,8 +86703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -86604,8 +86803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -86631,8 +86830,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -86642,7 +86841,7 @@ paths: application/json: schema: type: array - items: &592 + items: &594 title: Page Build description: Page Build type: object @@ -86717,7 +86916,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86736,8 +86935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *344 - - *345 + - *346 + - *347 responses: '201': description: Response @@ -86782,16 +86981,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *592 + schema: *594 examples: - default: &593 + default: &595 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -86839,8 +87038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *344 - - *345 + - *346 + - *347 - name: build_id in: path required: true @@ -86851,9 +87050,9 @@ paths: description: Response content: application/json: - schema: *592 + schema: *594 examples: - default: *593 + default: *595 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86873,8 +87072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -86979,9 +87178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *344 - - *345 - - &594 + - *346 + - *347 + - &596 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -87039,9 +87238,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *344 - - *345 - - *594 + - *346 + - *347 + - *596 responses: '204': *61 '404': *6 @@ -87068,8 +87267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -87300,7 +87499,7 @@ paths: description: Empty response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -87327,8 +87526,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Private vulnerability reporting status @@ -87365,8 +87564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': *61 '422': *14 @@ -87387,8 +87586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': *61 '422': *14 @@ -87410,8 +87609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -87419,7 +87618,7 @@ paths: application/json: schema: type: array - items: *295 + items: *297 examples: default: value: @@ -87450,8 +87649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -87463,7 +87662,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *295 + items: *297 required: - properties examples: @@ -87513,8 +87712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *344 - - *345 + - *346 + - *347 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -87574,11 +87773,11 @@ paths: application/json: schema: type: array - items: *482 + items: *484 examples: - default: *595 + default: *597 headers: - Link: *68 + Link: *70 '304': *37 '422': *15 x-github: @@ -87608,8 +87807,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -87674,7 +87873,7 @@ paths: description: Response content: application/json: - schema: &599 + schema: &601 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -87785,8 +87984,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *280 - required: *281 + properties: *282 + required: *283 nullable: true active_lock_reason: type: string @@ -87829,7 +88028,7 @@ paths: items: *4 requested_teams: type: array - items: *333 + items: *335 head: type: object properties: @@ -87837,7 +88036,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: *4 @@ -87854,7 +88053,7 @@ paths: type: string ref: type: string - repo: *80 + repo: *82 sha: type: string user: *4 @@ -87867,14 +88066,14 @@ paths: _links: type: object properties: - comments: *282 - commits: *282 - statuses: *282 - html: *282 - issue: *282 - review_comments: *282 - review_comment: *282 - self: *282 + comments: *284 + commits: *284 + statuses: *284 + html: *284 + issue: *284 + review_comments: *284 + review_comment: *284 + self: *284 required: - comments - commits @@ -87884,8 +88083,8 @@ paths: - review_comments - review_comment - self - author_association: *83 - auto_merge: *596 + author_association: *85 + auto_merge: *598 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -88071,7 +88270,7 @@ paths: - review_comments version: '2026-03-10' examples: - default: &600 + default: &602 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -88609,8 +88808,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *344 - - *345 + - *346 + - *347 - name: sort in: query required: false @@ -88629,7 +88828,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -88639,9 +88838,9 @@ paths: application/json: schema: type: array - items: *597 + items: *599 examples: - default: &602 + default: &604 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -88693,7 +88892,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88718,17 +88917,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 responses: '200': description: Response content: application/json: - schema: *597 + schema: *599 examples: - default: &598 + default: &600 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -88803,9 +89002,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 requestBody: required: true content: @@ -88827,9 +89026,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *599 examples: - default: *598 + default: *600 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88845,9 +89044,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 responses: '204': description: Response @@ -88868,9 +89067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -88896,11 +89095,11 @@ paths: application/json: schema: type: array - items: *476 + items: *478 examples: - default: *550 + default: *552 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -88919,9 +89118,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *344 - - *345 - - *102 + - *346 + - *347 + - *104 requestBody: required: true content: @@ -88953,16 +89152,16 @@ paths: description: Reaction exists content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '201': description: Reaction created content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '422': *15 x-github: githubCloudOnly: false @@ -88984,10 +89183,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *344 - - *345 - - *102 - - *551 + - *346 + - *347 + - *104 + - *553 responses: '204': description: Response @@ -89030,9 +89229,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *344 - - *345 - - &601 + - *346 + - *347 + - &603 name: pull_number description: The number that identifies the pull request. in: path @@ -89045,9 +89244,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *599 + schema: *601 examples: - default: *600 + default: *602 '304': *37 '404': *6 '406': @@ -89056,7 +89255,7 @@ paths: application/json: schema: *3 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89082,9 +89281,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 requestBody: required: false content: @@ -89126,9 +89325,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *601 examples: - default: *600 + default: *602 '422': *15 '403': *29 x-github: @@ -89150,9 +89349,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 responses: '204': description: Response @@ -89177,9 +89376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 responses: '204': description: Response @@ -89205,9 +89404,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 requestBody: required: true content: @@ -89267,21 +89466,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -89307,10 +89506,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *344 - - *345 - - *601 - - *110 + - *346 + - *347 + - *603 + - *112 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -89320,7 +89519,7 @@ paths: enum: - asc - desc - - *93 + - *95 - *17 - *19 responses: @@ -89330,11 +89529,11 @@ paths: application/json: schema: type: array - items: *597 + items: *599 examples: - default: *602 + default: *604 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89365,9 +89564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 requestBody: required: true content: @@ -89472,7 +89671,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *599 examples: example-for-a-multi-line-comment: value: @@ -89560,10 +89759,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *344 - - *345 - - *601 - - *102 + - *346 + - *347 + - *603 + - *104 requestBody: required: true content: @@ -89585,7 +89784,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *599 examples: default: value: @@ -89671,9 +89870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 - *17 - *19 responses: @@ -89683,11 +89882,11 @@ paths: application/json: schema: type: array - items: *478 + items: *480 examples: - default: *603 + default: *605 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89715,9 +89914,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 - *17 - *19 responses: @@ -89727,7 +89926,7 @@ paths: application/json: schema: type: array - items: *491 + items: *493 examples: default: value: @@ -89743,10 +89942,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *68 + Link: *70 '422': *15 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89765,9 +89964,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 responses: '204': description: Response if pull request has been merged @@ -89790,9 +89989,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 requestBody: required: false content: @@ -89903,9 +90102,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 responses: '200': description: Response @@ -89921,7 +90120,7 @@ paths: items: *4 teams: type: array - items: *195 + items: *197 required: - users - teams @@ -89962,7 +90161,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89980,9 +90179,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 requestBody: required: false content: @@ -90019,7 +90218,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *484 examples: default: value: @@ -90555,9 +90754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 requestBody: required: true content: @@ -90591,7 +90790,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *484 examples: default: value: @@ -91107,9 +91306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 - *17 - *19 responses: @@ -91119,7 +91318,7 @@ paths: application/json: schema: type: array - items: &604 + items: &606 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -91188,7 +91387,7 @@ paths: type: string body_text: type: string - author_association: *83 + author_association: *85 required: - id - node_id @@ -91237,7 +91436,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91270,9 +91469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 requestBody: required: false content: @@ -91358,9 +91557,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: - default: &606 + default: &608 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91423,10 +91622,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *344 - - *345 - - *601 - - &605 + - *346 + - *347 + - *603 + - &607 name: review_id description: The unique identifier of the review. in: path @@ -91438,9 +91637,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: - default: &607 + default: &609 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91499,10 +91698,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *344 - - *345 - - *601 - - *605 + - *346 + - *347 + - *603 + - *607 requestBody: required: true content: @@ -91525,7 +91724,7 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: default: value: @@ -91587,18 +91786,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *344 - - *345 - - *601 - - *605 + - *346 + - *347 + - *603 + - *607 responses: '200': description: Response content: application/json: - schema: *604 + schema: *606 examples: - default: *606 + default: *608 '422': *7 '404': *6 x-github: @@ -91625,10 +91824,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *344 - - *345 - - *601 - - *605 + - *346 + - *347 + - *603 + - *607 - *17 - *19 responses: @@ -91707,13 +91906,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *83 + author_association: *85 _links: type: object properties: - self: *282 - html: *282 - pull_request: *282 + self: *284 + html: *284 + pull_request: *284 required: - self - html @@ -91722,7 +91921,7 @@ paths: type: string body_html: type: string - reactions: *84 + reactions: *86 side: description: The side of the first line of the range for a multi-line comment. @@ -91834,7 +92033,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -91863,10 +92062,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *344 - - *345 - - *601 - - *605 + - *346 + - *347 + - *603 + - *607 requestBody: required: true content: @@ -91894,7 +92093,7 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: default: value: @@ -91957,10 +92156,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *344 - - *345 - - *601 - - *605 + - *346 + - *347 + - *603 + - *607 requestBody: required: true content: @@ -91995,9 +92194,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: - default: *607 + default: *609 '404': *6 '422': *7 '403': *29 @@ -92019,9 +92218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *344 - - *345 - - *601 + - *346 + - *347 + - *603 requestBody: required: false content: @@ -92084,8 +92283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *344 - - *345 + - *346 + - *347 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -92098,9 +92297,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: &609 + default: &611 value: type: file encoding: base64 @@ -92142,8 +92341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *344 - - *345 + - *346 + - *347 - name: dir description: The alternate path to look for a README file in: path @@ -92163,9 +92362,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: *609 + default: *611 '404': *6 '422': *15 x-github: @@ -92187,8 +92386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -92198,7 +92397,7 @@ paths: application/json: schema: type: array - items: *610 + items: *612 examples: default: value: @@ -92272,7 +92471,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -92292,8 +92491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -92369,9 +92568,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *612 examples: - default: &614 + default: &616 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -92476,9 +92675,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *344 - - *345 - - &612 + - *346 + - *347 + - &614 name: asset_id description: The unique identifier of the asset. in: path @@ -92490,9 +92689,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *613 examples: - default: &613 + default: &615 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -92527,7 +92726,7 @@ paths: type: User site_admin: false '404': *6 - '302': *495 + '302': *497 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92543,9 +92742,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *344 - - *345 - - *612 + - *346 + - *347 + - *614 requestBody: required: false content: @@ -92573,9 +92772,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *613 examples: - default: *613 + default: *615 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92591,9 +92790,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *344 - - *345 - - *612 + - *346 + - *347 + - *614 responses: '204': description: Response @@ -92618,8 +92817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -92704,16 +92903,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *610 + schema: *612 examples: - default: *614 + default: *616 '404': *6 x-github: githubCloudOnly: false @@ -92731,8 +92930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *344 - - *345 + - *346 + - *347 - name: tag description: tag parameter in: path @@ -92745,9 +92944,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *612 examples: - default: *614 + default: *616 '404': *6 x-github: githubCloudOnly: false @@ -92769,9 +92968,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *344 - - *345 - - &615 + - *346 + - *347 + - &617 name: release_id description: The unique identifier of the release. in: path @@ -92785,9 +92984,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *610 + schema: *612 examples: - default: *614 + default: *616 '401': description: Unauthorized x-github: @@ -92805,9 +93004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *344 - - *345 - - *615 + - *346 + - *347 + - *617 requestBody: required: false content: @@ -92871,9 +93070,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *612 examples: - default: *614 + default: *616 '404': description: Not Found if the discussion category name is invalid content: @@ -92894,9 +93093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *344 - - *345 - - *615 + - *346 + - *347 + - *617 responses: '204': description: Response @@ -92917,9 +93116,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *344 - - *345 - - *615 + - *346 + - *347 + - *617 - *17 - *19 responses: @@ -92929,7 +93128,7 @@ paths: application/json: schema: type: array - items: *611 + items: *613 examples: default: value: @@ -92966,7 +93165,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93010,9 +93209,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *344 - - *345 - - *615 + - *346 + - *347 + - *617 - name: name in: query required: true @@ -93038,7 +93237,7 @@ paths: description: Response for successful upload content: application/json: - schema: *611 + schema: *613 examples: response-for-successful-upload: value: @@ -93093,9 +93292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *344 - - *345 - - *615 + - *346 + - *347 + - *617 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -93119,11 +93318,11 @@ paths: application/json: schema: type: array - items: *476 + items: *478 examples: - default: *550 + default: *552 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -93142,9 +93341,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *344 - - *345 - - *615 + - *346 + - *347 + - *617 requestBody: required: true content: @@ -93174,16 +93373,16 @@ paths: description: Reaction exists content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '201': description: Reaction created content: application/json: - schema: *476 + schema: *478 examples: - default: *477 + default: *479 '422': *15 x-github: githubCloudOnly: false @@ -93205,10 +93404,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *344 - - *345 - - *615 - - *551 + - *346 + - *347 + - *617 + - *553 responses: '204': description: Response @@ -93232,9 +93431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *344 - - *345 - - *411 + - *346 + - *347 + - *413 - *17 - *19 responses: @@ -93250,8 +93449,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *305 - - &616 + - *307 + - &618 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -93270,69 +93469,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *306 - - *616 - - allOf: - - *307 - - *616 - allOf: - *308 - - *616 - - allOf: - - *617 - - *616 + - *618 - allOf: - *309 - - *616 + - *618 - allOf: - *310 - - *616 + - *618 + - allOf: + - *619 + - *618 - allOf: - *311 - - *616 + - *618 - allOf: - *312 - - *616 + - *618 - allOf: - *313 - - *616 + - *618 - allOf: - *314 - - *616 + - *618 - allOf: - *315 - - *616 + - *618 - allOf: - *316 - - *616 + - *618 - allOf: - *317 - - *616 + - *618 - allOf: - *318 - - *616 + - *618 - allOf: - *319 - - *616 + - *618 - allOf: - *320 - - *616 + - *618 - allOf: - *321 - - *616 + - *618 - allOf: - *322 - - *616 + - *618 - allOf: - *323 - - *616 + - *618 - allOf: - *324 - - *616 + - *618 - allOf: - *325 - - *616 + - *618 + - allOf: + - *326 + - *618 + - allOf: + - *327 + - *618 examples: default: value: @@ -93371,8 +93570,8 @@ paths: category: repos subcategory: rules parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 - name: includes_parents @@ -93383,7 +93582,7 @@ paths: schema: type: boolean default: true - - *618 + - *620 responses: '200': description: Response @@ -93391,7 +93590,7 @@ paths: application/json: schema: type: array - items: *326 + items: *328 examples: default: value: @@ -93438,8 +93637,8 @@ paths: category: repos subcategory: rules parameters: - - *344 - - *345 + - *346 + - *347 requestBody: description: Request body required: true @@ -93459,16 +93658,16 @@ paths: - tag - push default: branch - enforcement: *302 + enforcement: *304 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *300 + items: *305 + conditions: *302 rules: type: array description: An array of rules within the ruleset. - items: *619 + items: *621 required: - name - enforcement @@ -93499,9 +93698,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *328 examples: - default: &629 + default: &631 value: id: 42 name: super cool ruleset @@ -93549,12 +93748,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *344 - - *345 - - *620 - - *621 + - *346 + - *347 - *622 - *623 + - *624 + - *625 - *17 - *19 responses: @@ -93562,9 +93761,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *626 examples: - default: *625 + default: *627 '404': *6 '500': *55 x-github: @@ -93585,17 +93784,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *344 - - *345 - - *626 + - *346 + - *347 + - *628 responses: '200': description: Response content: application/json: - schema: *627 + schema: *629 examples: - default: *628 + default: *630 '404': *6 '500': *55 x-github: @@ -93623,8 +93822,8 @@ paths: category: repos subcategory: rules parameters: - - *344 - - *345 + - *346 + - *347 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93644,9 +93843,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *328 examples: - default: *629 + default: *631 '404': *6 '500': *55 put: @@ -93664,8 +93863,8 @@ paths: category: repos subcategory: rules parameters: - - *344 - - *345 + - *346 + - *347 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93690,16 +93889,16 @@ paths: - branch - tag - push - enforcement: *302 + enforcement: *304 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *300 + items: *305 + conditions: *302 rules: description: An array of rules within the ruleset. type: array - items: *619 + items: *621 examples: default: value: @@ -93727,9 +93926,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *328 examples: - default: *629 + default: *631 '404': *6 '422': *15 '500': *55 @@ -93748,8 +93947,8 @@ paths: category: repos subcategory: rules parameters: - - *344 - - *345 + - *346 + - *347 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93772,8 +93971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 - name: ruleset_id @@ -93789,9 +93988,9 @@ paths: application/json: schema: type: array - items: *329 + items: *331 examples: - default: *630 + default: *632 '404': *6 '500': *55 x-github: @@ -93810,8 +94009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *344 - - *345 + - *346 + - *347 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93829,7 +94028,7 @@ paths: description: Response content: application/json: - schema: *631 + schema: *633 examples: default: value: @@ -93884,25 +94083,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *344 - - *345 - - *632 - - *633 + - *346 + - *347 - *634 - *635 - *636 - *637 - *638 - *639 + - *640 + - *641 - *62 - *19 - *17 - - *640 - - *641 - *642 - *643 - *644 - *645 + - *646 + - *647 responses: '200': description: Response @@ -93910,11 +94109,11 @@ paths: application/json: schema: type: array - items: &649 + items: &651 type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -93922,15 +94121,15 @@ paths: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *646 - resolution: *647 + state: *648 + resolution: *649 resolved_at: type: string format: date-time @@ -94036,7 +94235,7 @@ paths: pull request. ' - oneOf: *648 + oneOf: *650 nullable: true has_more_locations: type: boolean @@ -94178,7 +94377,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94200,16 +94399,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *344 - - *345 - - *442 - - *645 + - *346 + - *347 + - *444 + - *647 responses: '200': description: Response content: application/json: - schema: *649 + schema: *651 examples: default: value: @@ -94240,7 +94439,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94263,9 +94462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *344 - - *345 - - *442 + - *346 + - *347 + - *444 requestBody: required: true content: @@ -94273,8 +94472,8 @@ paths: schema: type: object properties: - state: *646 - resolution: *647 + state: *648 + resolution: *649 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -94285,6 +94484,14 @@ paths: to `null` to unassign the alert. type: string nullable: true + validity: + type: string + nullable: true + enum: + - active + - inactive + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -94310,7 +94517,7 @@ paths: description: Response content: application/json: - schema: *649 + schema: *651 examples: default: value: @@ -94382,8 +94589,9 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository - '503': *120 + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -94405,9 +94613,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *344 - - *345 - - *442 + - *346 + - *347 + - *444 - *19 - *17 responses: @@ -94418,7 +94626,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &807 + items: &809 type: object properties: type: @@ -94444,8 +94652,6 @@ paths: example: commit details: oneOf: - - *650 - - *651 - *652 - *653 - *654 @@ -94457,6 +94663,8 @@ paths: - *660 - *661 - *662 + - *663 + - *664 examples: default: value: @@ -94516,11 +94724,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *68 + Link: *70 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94542,8 +94750,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -94551,14 +94759,14 @@ paths: schema: type: object properties: - reason: &664 + reason: &666 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *663 + placeholder_id: *665 required: - reason - placeholder_id @@ -94575,7 +94783,7 @@ paths: schema: type: object properties: - reason: *664 + reason: *666 expire_at: type: string format: date-time @@ -94598,7 +94806,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *120 + '503': *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -94621,13 +94829,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *120 + '503': *122 '200': description: Response content: @@ -94637,7 +94845,7 @@ paths: properties: incremental_scans: type: array - items: &665 + items: &667 description: Information on a single scan performed by secret scanning on the repository type: object @@ -94663,15 +94871,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *665 + items: *667 backfill_scans: type: array - items: *665 + items: *667 custom_pattern_backfill_scans: type: array items: allOf: - - *665 + - *667 - type: object properties: pattern_name: @@ -94684,7 +94892,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *665 + items: *667 examples: default: value: @@ -94749,8 +94957,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *344 - - *345 + - *346 + - *347 - *62 - name: sort description: The property to sort the results by. @@ -94794,9 +95002,9 @@ paths: application/json: schema: type: array - items: *666 + items: *668 examples: - default: *667 + default: *669 '400': *14 '404': *6 x-github: @@ -94819,8 +95027,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -94893,7 +95101,7 @@ paths: login: type: string description: The username of the user credited. - type: *332 + type: *334 required: - login - type @@ -94980,9 +95188,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: &669 + default: &671 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -95221,8 +95429,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -95326,7 +95534,7 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: default: value: @@ -95479,17 +95687,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *344 - - *345 - - *668 + - *346 + - *347 + - *670 responses: '200': description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: *669 + default: *671 '403': *29 '404': *6 x-github: @@ -95513,9 +95721,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *344 - - *345 - - *668 + - *346 + - *347 + - *670 requestBody: required: true content: @@ -95588,7 +95796,7 @@ paths: login: type: string description: The username of the user credited. - type: *332 + type: *334 required: - login - type @@ -95674,17 +95882,17 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: - default: *669 - add_credit: *669 + default: *671 + add_credit: *671 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *128 + schema: *130 examples: invalid_state_transition: value: @@ -95715,9 +95923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *344 - - *345 - - *668 + - *346 + - *347 + - *670 responses: '202': *39 '400': *14 @@ -95744,17 +95952,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *344 - - *345 - - *668 + - *346 + - *347 + - *670 responses: '202': description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *349 + default: *351 '400': *14 '422': *15 '403': *29 @@ -95780,8 +95988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -95858,7 +96066,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -95880,8 +96088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -95890,7 +96098,7 @@ paths: application/json: schema: type: array - items: &670 + items: &672 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -95923,8 +96131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -96000,8 +96208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -96097,8 +96305,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -96252,8 +96460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -96263,7 +96471,7 @@ paths: application/json: schema: type: array - items: *670 + items: *672 examples: default: value: @@ -96296,8 +96504,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *344 - - *345 + - *346 + - *347 - name: sha in: path required: true @@ -96351,7 +96559,7 @@ paths: description: Response content: application/json: - schema: *671 + schema: *673 examples: default: value: @@ -96405,8 +96613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -96418,9 +96626,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96438,14 +96646,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &672 + schema: &674 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -96513,8 +96721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: false content: @@ -96540,7 +96748,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: default: value: @@ -96567,8 +96775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -96588,8 +96796,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -96645,7 +96853,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96668,8 +96876,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *344 - - *345 + - *346 + - *347 - name: ref in: path required: true @@ -96705,8 +96913,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *344 - - *345 + - *346 + - *347 - *17 - *19 responses: @@ -96716,11 +96924,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - default: *260 + default: *262 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -96738,8 +96946,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *344 - - *345 + - *346 + - *347 - *19 - *17 responses: @@ -96747,7 +96955,7 @@ paths: description: Response content: application/json: - schema: &673 + schema: &675 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -96759,7 +96967,7 @@ paths: required: - names examples: - default: &674 + default: &676 value: names: - octocat @@ -96782,8 +96990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -96814,9 +97022,9 @@ paths: description: Response content: application/json: - schema: *673 + schema: *675 examples: - default: *674 + default: *676 '404': *6 '422': *7 x-github: @@ -96837,9 +97045,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *344 - - *345 - - &675 + - *346 + - *347 + - &677 name: per description: The time frame to display results for. in: query @@ -96868,7 +97076,7 @@ paths: example: 128 clones: type: array - items: &676 + items: &678 title: Traffic type: object properties: @@ -96955,8 +97163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -97046,8 +97254,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *344 - - *345 + - *346 + - *347 responses: '200': description: Response @@ -97107,9 +97315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *344 - - *345 - - *675 + - *346 + - *347 + - *677 responses: '200': description: Response @@ -97128,7 +97336,7 @@ paths: example: 3782 views: type: array - items: *676 + items: *678 required: - uniques - count @@ -97205,8 +97413,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *344 - - *345 + - *346 + - *347 requestBody: required: true content: @@ -97242,7 +97450,7 @@ paths: description: Response content: application/json: - schema: *159 + schema: *161 examples: default: value: @@ -97486,8 +97694,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -97510,8 +97718,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -97533,8 +97741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -97560,8 +97768,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *344 - - *345 + - *346 + - *347 - name: ref in: path required: true @@ -97653,9 +97861,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *349 + default: *351 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -97696,7 +97904,7 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: default: value: @@ -97888,7 +98096,7 @@ paths: html_url: type: string format: uri - repository: *159 + repository: *161 score: type: number file_size: @@ -97906,7 +98114,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &677 + text_matches: &679 title: Search Result Text Matches type: array items: @@ -98020,7 +98228,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *120 + '503': *122 '422': *15 '403': *29 x-github: @@ -98068,7 +98276,7 @@ paths: enum: - author-date - committer-date - - &678 + - &680 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -98139,7 +98347,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *409 + properties: *411 nullable: true comment_count: type: integer @@ -98159,7 +98367,7 @@ paths: url: type: string format: uri - verification: *533 + verification: *535 required: - author - committer @@ -98178,7 +98386,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *409 + properties: *411 nullable: true parents: type: array @@ -98191,12 +98399,12 @@ paths: type: string sha: type: string - repository: *159 + repository: *161 score: type: number node_id: type: string - text_matches: *677 + text_matches: *679 required: - sha - node_id @@ -98388,7 +98596,7 @@ paths: - interactions - created - updated - - *678 + - *680 - *17 - *19 - name: advanced_search @@ -98502,11 +98710,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: type: string state_reason: @@ -98523,8 +98731,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *280 - required: *281 + properties: *282 + required: *283 nullable: true comments: type: integer @@ -98538,7 +98746,7 @@ paths: type: string format: date-time nullable: true - text_matches: *677 + text_matches: *679 pull_request: type: object properties: @@ -98571,10 +98779,10 @@ paths: type: string score: type: number - author_association: *83 + author_association: *85 draft: type: boolean - repository: *80 + repository: *82 body_html: type: string body_text: @@ -98582,7 +98790,7 @@ paths: timeline_url: type: string format: uri - type: *243 + type: *245 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -98592,17 +98800,17 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 pinned_comment: title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - reactions: *84 + reactions: *86 required: - assignee - closed_at @@ -98790,7 +98998,7 @@ paths: - quoted_text items: - "..." - '503': *120 + '503': *122 '422': *15 '304': *37 '403': *29 @@ -98844,7 +99052,7 @@ paths: enum: - created - updated - - *678 + - *680 - *17 - *19 responses: @@ -98888,7 +99096,7 @@ paths: nullable: true score: type: number - text_matches: *677 + text_matches: *679 required: - id - node_id @@ -98973,7 +99181,7 @@ paths: - forks - help-wanted-issues - updated - - *678 + - *680 - *17 - *19 responses: @@ -99201,8 +99409,8 @@ paths: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true permissions: type: object @@ -99221,7 +99429,7 @@ paths: - admin - pull - push - text_matches: *677 + text_matches: *679 temp_clone_token: type: string allow_merge_commit: @@ -99423,7 +99631,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *120 + '503': *122 '422': *15 '304': *37 x-github: @@ -99521,7 +99729,7 @@ paths: type: string format: uri nullable: true - text_matches: *677 + text_matches: *679 related: type: array nullable: true @@ -99712,7 +99920,7 @@ paths: - followers - repositories - joined - - *678 + - *680 - *17 - *19 responses: @@ -99816,7 +100024,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *677 + text_matches: *679 blog: type: string nullable: true @@ -99875,7 +100083,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *120 + '503': *122 '422': *15 x-github: githubCloudOnly: false @@ -99895,7 +100103,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &681 + - &683 name: team_id description: The unique identifier of the team. in: path @@ -99907,9 +100115,9 @@ paths: description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *341 + default: *343 '404': *6 x-github: githubCloudOnly: false @@ -99936,7 +100144,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *681 + - *683 requestBody: required: true content: @@ -99999,16 +100207,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *340 + schema: *342 examples: - default: *341 + default: *343 '201': description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *341 + default: *343 '404': *6 '422': *15 '403': *29 @@ -100036,7 +100244,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *681 + - *683 responses: '204': description: Response @@ -100065,7 +100273,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -100075,11 +100283,11 @@ paths: application/json: schema: type: array - items: *237 + items: *239 examples: - default: *238 + default: *240 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100103,7 +100311,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *681 + - *683 - name: role description: Filters members returned by their role in the team. in: query @@ -100126,9 +100334,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -100154,8 +100362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *681 - - *72 + - *683 + - *74 responses: '204': description: if user is a member @@ -100191,8 +100399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *681 - - *72 + - *683 + - *74 responses: '204': description: Response @@ -100231,8 +100439,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *681 - - *72 + - *683 + - *74 responses: '204': description: Response @@ -100268,16 +100476,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *681 - - *72 + - *683 + - *74 responses: '200': description: Response content: application/json: - schema: *343 + schema: *345 examples: - response-if-user-is-a-team-maintainer: *682 + response-if-user-is-a-team-maintainer: *684 '404': *6 x-github: githubCloudOnly: false @@ -100310,8 +100518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *681 - - *72 + - *683 + - *74 requestBody: required: false content: @@ -100336,9 +100544,9 @@ paths: description: Response content: application/json: - schema: *343 + schema: *345 examples: - response-if-users-membership-with-team-is-now-pending: *683 + response-if-users-membership-with-team-is-now-pending: *685 '403': description: Forbidden if team synchronization is set up '422': @@ -100372,8 +100580,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *681 - - *72 + - *683 + - *74 responses: '204': description: Response @@ -100400,7 +100608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -100410,11 +100618,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -100442,15 +100650,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *681 - - *344 - - *345 + - *683 + - *346 + - *347 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *684 + schema: *686 examples: alternative-response-with-extra-repository-information: value: @@ -100607,9 +100815,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *681 - - *344 - - *345 + - *683 + - *346 + - *347 requestBody: required: false content: @@ -100659,9 +100867,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *681 - - *344 - - *345 + - *683 + - *346 + - *347 responses: '204': description: Response @@ -100686,7 +100894,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *681 + - *683 - *17 - *19 responses: @@ -100696,11 +100904,11 @@ paths: application/json: schema: type: array - items: *195 + items: *197 examples: - response-if-child-teams-exist: *685 + response-if-child-teams-exist: *687 headers: - Link: *68 + Link: *70 '404': *6 '403': *29 '422': *15 @@ -100731,7 +100939,7 @@ paths: application/json: schema: oneOf: - - &687 + - &689 title: Private User description: Private User type: object @@ -100934,7 +101142,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *686 + - *688 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -101087,7 +101295,7 @@ paths: description: Response content: application/json: - schema: *687 + schema: *689 examples: default: value: @@ -101166,7 +101374,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 '304': *37 '404': *6 '403': *29 @@ -101189,7 +101397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *72 + - *74 responses: '204': description: If the user is blocked @@ -101217,7 +101425,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -101241,7 +101449,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -101290,9 +101498,9 @@ paths: type: integer codespaces: type: array - items: *248 + items: *250 examples: - default: *249 + default: *251 '304': *37 '500': *55 '401': *25 @@ -101431,21 +101639,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '401': *25 '403': *29 '404': *6 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101485,7 +101693,7 @@ paths: type: integer secrets: type: array - items: &688 + items: &690 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -101525,9 +101733,9 @@ paths: - visibility - selected_repositories_url examples: - default: *468 + default: *470 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101595,13 +101803,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 responses: '200': description: Response content: application/json: - schema: *688 + schema: *690 examples: default: value: @@ -101631,7 +101839,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 requestBody: required: true content: @@ -101676,7 +101884,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -101704,7 +101912,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *167 + - *169 responses: '204': description: Response @@ -101729,7 +101937,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *167 + - *169 responses: '200': description: Response @@ -101745,9 +101953,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *161 examples: - default: *196 + default: *198 '401': *25 '403': *29 '404': *6 @@ -101772,7 +101980,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *167 + - *169 requestBody: required: true content: @@ -101826,7 +102034,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *167 + - *169 - name: repository_id in: path required: true @@ -101859,7 +102067,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *167 + - *169 - name: repository_id in: path required: true @@ -101891,15 +102099,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *250 + - *252 responses: '200': description: Response content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '304': *37 '500': *55 '401': *25 @@ -101925,7 +102133,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *250 + - *252 requestBody: required: false content: @@ -101955,9 +102163,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '401': *25 '403': *29 '404': *6 @@ -101979,7 +102187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *250 + - *252 responses: '202': *39 '304': *37 @@ -102008,13 +102216,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *250 + - *252 responses: '202': description: Response content: application/json: - schema: &689 + schema: &691 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -102055,7 +102263,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &690 + default: &692 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -102087,7 +102295,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *250 + - *252 - name: export_id in: path required: true @@ -102100,9 +102308,9 @@ paths: description: Response content: application/json: - schema: *689 + schema: *691 examples: - default: *690 + default: *692 '404': *6 x-github: githubCloudOnly: false @@ -102123,7 +102331,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *250 + - *252 responses: '200': description: Response @@ -102139,9 +102347,9 @@ paths: type: integer machines: type: array - items: *691 + items: *693 examples: - default: *692 + default: *694 '304': *37 '500': *55 '401': *25 @@ -102170,7 +102378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *250 + - *252 requestBody: required: true content: @@ -102220,13 +102428,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *347 + repository: *349 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *466 - required: *467 + properties: *468 + required: *469 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -103000,15 +103208,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *250 + - *252 responses: '200': description: Response content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '304': *37 '500': *55 '400': *14 @@ -103040,15 +103248,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *250 + - *252 responses: '200': description: Response content: application/json: - schema: *248 + schema: *250 examples: - default: *465 + default: *467 '500': *55 '401': *25 '403': *29 @@ -103078,9 +103286,9 @@ paths: application/json: schema: type: array - items: *261 + items: *263 examples: - default: &703 + default: &705 value: - id: 197 name: hello_docker @@ -103181,7 +103389,7 @@ paths: application/json: schema: type: array - items: &693 + items: &695 title: Email description: Email type: object @@ -103246,16 +103454,16 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: - default: &705 + default: &707 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -103323,7 +103531,7 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: default: value: @@ -103433,9 +103641,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -103466,9 +103674,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -103488,7 +103696,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *72 + - *74 responses: '204': description: if the person is followed by the authenticated user @@ -103518,7 +103726,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -103543,7 +103751,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *72 + - *74 responses: '204': description: Response @@ -103579,7 +103787,7 @@ paths: application/json: schema: type: array - items: &694 + items: &696 title: GPG Key description: A unique encryption key type: object @@ -103710,7 +103918,7 @@ paths: - subkeys - revoked examples: - default: &721 + default: &723 value: - id: 3 name: Octocat's GPG Key @@ -103742,7 +103950,7 @@ paths: revoked: false raw_key: string headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -103795,9 +104003,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *696 examples: - default: &695 + default: &697 value: id: 3 name: Octocat's GPG Key @@ -103854,7 +104062,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &696 + - &698 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -103866,9 +104074,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *696 examples: - default: *695 + default: *697 '404': *6 '304': *37 '403': *29 @@ -103891,7 +104099,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *696 + - *698 responses: '204': description: Response @@ -104034,7 +104242,7 @@ paths: suspended_at: suspended_by: headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -104082,11 +104290,11 @@ paths: type: array items: allOf: - - *80 + - *82 examples: - default: *151 + default: *153 headers: - Link: *68 + Link: *70 '404': *6 '403': *29 '304': *37 @@ -104110,7 +104318,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *148 + - *150 responses: '204': description: Response @@ -104136,7 +104344,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *148 + - *150 responses: '204': description: Response @@ -104170,12 +104378,12 @@ paths: application/json: schema: anyOf: - - *235 + - *237 - type: object properties: {} additionalProperties: false examples: - default: *236 + default: *238 '204': description: Response when there are no restrictions x-github: @@ -104199,7 +104407,7 @@ paths: required: true content: application/json: - schema: *544 + schema: *546 examples: default: value: @@ -104210,7 +104418,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *237 examples: default: value: @@ -104291,7 +104499,7 @@ paths: - closed - all default: open - - *246 + - *248 - name: sort description: What to sort results by. in: query @@ -104304,7 +104512,7 @@ paths: - comments default: created - *62 - - *93 + - *95 - *17 - *19 responses: @@ -104314,11 +104522,11 @@ paths: application/json: schema: type: array - items: *86 + items: *88 examples: - default: *247 + default: *249 headers: - Link: *68 + Link: *70 '404': *6 '304': *37 x-github: @@ -104349,7 +104557,7 @@ paths: application/json: schema: type: array - items: &697 + items: &699 title: Key description: Key type: object @@ -104400,7 +104608,7 @@ paths: verified: false read_only: false headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -104450,9 +104658,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *699 examples: - default: &698 + default: &700 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -104485,15 +104693,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *580 + - *582 responses: '200': description: Response content: application/json: - schema: *697 + schema: *699 examples: - default: *698 + default: *700 '404': *6 '304': *37 '403': *29 @@ -104516,7 +104724,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *580 + - *582 responses: '204': description: Response @@ -104549,7 +104757,7 @@ paths: application/json: schema: type: array - items: &699 + items: &701 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -104606,7 +104814,7 @@ paths: - id - type - login - plan: *104 + plan: *106 required: - billing_cycle - next_billing_date @@ -104617,7 +104825,7 @@ paths: - account - plan examples: - default: &700 + default: &702 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -104650,7 +104858,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *68 + Link: *70 '304': *37 '401': *25 '404': *6 @@ -104679,11 +104887,11 @@ paths: application/json: schema: type: array - items: *699 + items: *701 examples: - default: *700 + default: *702 headers: - Link: *68 + Link: *70 '304': *37 '401': *25 x-github: @@ -104721,7 +104929,7 @@ paths: application/json: schema: type: array - items: *252 + items: *254 examples: default: value: @@ -104804,7 +105012,7 @@ paths: type: User site_admin: false headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -104829,13 +105037,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *76 + - *78 responses: '200': description: Response content: application/json: - schema: *252 + schema: *254 examples: default: value: @@ -104897,7 +105105,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *76 + - *78 requestBody: required: true content: @@ -104922,7 +105130,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *254 examples: default: value: @@ -104994,7 +105202,7 @@ paths: application/json: schema: type: array - items: *254 + items: *256 examples: default: value: @@ -105147,7 +105355,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -105247,7 +105455,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *256 examples: default: value: @@ -105427,7 +105635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *255 + - *257 - name: exclude in: query required: false @@ -105440,7 +105648,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *256 examples: default: value: @@ -105634,7 +105842,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *255 + - *257 responses: '302': description: Response @@ -105660,7 +105868,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *255 + - *257 responses: '204': description: Response @@ -105689,8 +105897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *255 - - *701 + - *257 + - *703 responses: '204': description: Response @@ -105714,7 +105922,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *255 + - *257 - *17 - *19 responses: @@ -105724,11 +105932,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 '404': *6 x-github: githubCloudOnly: false @@ -105779,11 +105987,11 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -105823,7 +106031,7 @@ paths: - docker - nuget - container - - *702 + - *704 - *19 - *17 responses: @@ -105833,10 +106041,10 @@ paths: application/json: schema: type: array - items: *261 + items: *263 examples: - default: *703 - '400': *704 + default: *705 + '400': *706 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105856,16 +106064,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *263 - - *264 + - *265 + - *266 responses: '200': description: Response content: application/json: - schema: *261 + schema: *263 examples: - default: &722 + default: &724 value: id: 40201 name: octo-name @@ -105978,8 +106186,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *263 - - *264 + - *265 + - *266 responses: '204': description: Response @@ -106009,8 +106217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *263 - - *264 + - *265 + - *266 - name: token description: package token schema: @@ -106042,8 +106250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *263 - - *264 + - *265 + - *266 - *19 - *17 - name: state @@ -106063,7 +106271,7 @@ paths: application/json: schema: type: array - items: *265 + items: *267 examples: default: value: @@ -106112,15 +106320,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *263 - - *264 + - *265 - *266 + - *268 responses: '200': description: Response content: application/json: - schema: *265 + schema: *267 examples: default: value: @@ -106156,9 +106364,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *263 - - *264 + - *265 - *266 + - *268 responses: '204': description: Response @@ -106188,9 +106396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *263 - - *264 + - *265 - *266 + - *268 responses: '204': description: Response @@ -106227,11 +106435,11 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: - default: *705 + default: *707 headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -106340,9 +106548,9 @@ paths: application/json: schema: type: array - items: *80 + items: *82 examples: - default: &712 + default: &714 summary: Default response value: - id: 1296269 @@ -106463,7 +106671,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '422': *15 '304': *37 '403': *29 @@ -106646,9 +106854,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *349 + default: *351 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106692,11 +106900,11 @@ paths: application/json: schema: type: array - items: *546 + items: *548 examples: - default: *706 + default: *708 headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -106717,7 +106925,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *239 + - *241 responses: '204': description: Response @@ -106746,7 +106954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *239 + - *241 responses: '204': description: Response @@ -106779,7 +106987,7 @@ paths: application/json: schema: type: array - items: &707 + items: &709 title: Social account description: Social media account type: object @@ -106794,12 +107002,12 @@ paths: - provider - url examples: - default: &708 + default: &710 value: - provider: twitter url: https://twitter.com/github headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -106856,9 +107064,9 @@ paths: application/json: schema: type: array - items: *707 + items: *709 examples: - default: *708 + default: *710 '422': *15 '304': *37 '404': *6 @@ -106945,7 +107153,7 @@ paths: application/json: schema: type: array - items: &709 + items: &711 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -106965,7 +107173,7 @@ paths: - title - created_at examples: - default: &740 + default: &742 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -106976,7 +107184,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -107029,9 +107237,9 @@ paths: description: Response content: application/json: - schema: *709 + schema: *711 examples: - default: &710 + default: &712 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107061,7 +107269,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &711 + - &713 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -107073,9 +107281,9 @@ paths: description: Response content: application/json: - schema: *709 + schema: *711 examples: - default: *710 + default: *712 '404': *6 '304': *37 '403': *29 @@ -107098,7 +107306,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *711 + - *713 responses: '204': description: Response @@ -107127,7 +107335,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &741 + - &743 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -107150,13 +107358,13 @@ paths: application/json: schema: type: array - items: *80 + items: *82 examples: - default-response: *712 + default-response: *714 application/vnd.github.v3.star+json: schema: type: array - items: &742 + items: &744 title: Starred Repository description: Starred Repository type: object @@ -107164,7 +107372,7 @@ paths: starred_at: type: string format: date-time - repo: *80 + repo: *82 required: - starred_at - repo @@ -107292,7 +107500,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -107312,8 +107520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response if this repository is starred by you @@ -107341,8 +107549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -107366,8 +107574,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *344 - - *345 + - *346 + - *347 responses: '204': description: Response @@ -107400,11 +107608,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -107439,7 +107647,7 @@ paths: application/json: schema: type: array - items: *340 + items: *342 examples: default: value: @@ -107490,7 +107698,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *68 + Link: *70 '304': *37 '404': *6 '403': *29 @@ -107517,7 +107725,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *106 + - *108 responses: '200': description: Response @@ -107525,10 +107733,10 @@ paths: application/json: schema: oneOf: - - *687 - - *686 + - *689 + - *688 examples: - default-response: &716 + default-response: &718 summary: Default response value: login: octocat @@ -107563,7 +107771,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &717 + response-with-git-hub-plan-information: &719 summary: Response with GitHub plan information value: login: octocat @@ -107620,14 +107828,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &714 + - &716 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *279 + - *281 requestBody: required: true description: Details of the draft item to create in the project. @@ -107661,9 +107869,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *287 examples: - draft_issue: *286 + draft_issue: *288 '304': *37 '403': *29 '401': *25 @@ -107686,7 +107894,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *713 + - *715 - *17 responses: '200': @@ -107697,7 +107905,7 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: Link: example: ; rel="next" @@ -107721,8 +107929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *714 - - *279 + - *716 + - *281 requestBody: required: true content: @@ -107793,17 +108001,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *715 + schema: *717 examples: table_view: summary: Response for creating a table view - value: *290 + value: *292 board_view: summary: Response for creating a board view with filter - value: *290 + value: *292 roadmap_view: summary: Response for creating a roadmap view - value: *290 + value: *292 '304': *37 '403': *29 '401': *25 @@ -107837,7 +108045,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *72 + - *74 responses: '200': description: Response @@ -107845,11 +108053,11 @@ paths: application/json: schema: oneOf: - - *687 - - *686 + - *689 + - *688 examples: - default-response: *716 - response-with-git-hub-plan-information: *717 + default-response: *718 + response-with-git-hub-plan-information: *719 '404': *6 x-github: githubCloudOnly: false @@ -107875,7 +108083,7 @@ paths: - *17 - *47 - *48 - - *72 + - *74 requestBody: required: true content: @@ -107899,8 +108107,8 @@ paths: required: - subject_digests examples: - default: *718 - withPredicateType: *719 + default: *720 + withPredicateType: *721 responses: '200': description: Response @@ -107953,7 +108161,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *720 + default: *722 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107986,7 +108194,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *72 + - *74 requestBody: required: true content: @@ -108051,7 +108259,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *72 + - *74 - name: subject_digest description: Subject Digest in: path @@ -108082,7 +108290,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *72 + - *74 - name: attestation_id description: Attestation ID in: path @@ -108120,7 +108328,7 @@ paths: - *17 - *47 - *48 - - *72 + - *74 - name: subject_digest description: Subject Digest in: path @@ -108173,12 +108381,12 @@ paths: initiator: type: string examples: - default: *405 + default: *407 '201': description: Response content: application/json: - schema: *168 + schema: *170 examples: default: value: @@ -108218,7 +108426,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *72 + - *74 responses: '200': description: Response @@ -108226,9 +108434,9 @@ paths: application/json: schema: type: array - items: *261 + items: *263 examples: - default: *703 + default: *705 '403': *29 '401': *25 x-github: @@ -108251,7 +108459,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108261,7 +108469,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -108323,8 +108531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *72 - - *76 + - *74 + - *78 - *17 - *19 responses: @@ -108334,7 +108542,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -108411,7 +108619,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108421,7 +108629,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -108479,7 +108687,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108491,9 +108699,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108510,7 +108718,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108522,9 +108730,9 @@ paths: type: array items: *4 examples: - default: *71 + default: *73 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108541,7 +108749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *72 + - *74 - name: target_user in: path required: true @@ -108568,8 +108776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *72 - - *93 + - *74 + - *95 - *17 - *19 responses: @@ -108579,11 +108787,11 @@ paths: application/json: schema: type: array - items: *94 + items: *96 examples: - default: *95 + default: *97 headers: - Link: *68 + Link: *70 '422': *15 x-github: githubCloudOnly: false @@ -108602,7 +108810,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108612,11 +108820,11 @@ paths: application/json: schema: type: array - items: *694 + items: *696 examples: - default: *721 + default: *723 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108638,7 +108846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *72 + - *74 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -108710,7 +108918,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *72 + - *74 responses: '200': description: Response @@ -108718,7 +108926,7 @@ paths: application/json: schema: *22 examples: - default: *543 + default: *545 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108736,7 +108944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108771,7 +108979,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108791,7 +108999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -108801,11 +109009,11 @@ paths: application/json: schema: type: array - items: *74 + items: *76 examples: - default: *117 + default: *119 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108842,8 +109050,8 @@ paths: - docker - nuget - container - - *702 - - *72 + - *704 + - *74 - *19 - *17 responses: @@ -108853,12 +109061,12 @@ paths: application/json: schema: type: array - items: *261 + items: *263 examples: - default: *703 + default: *705 '403': *29 '401': *25 - '400': *704 + '400': *706 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108878,17 +109086,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *263 - - *264 - - *72 + - *265 + - *266 + - *74 responses: '200': description: Response content: application/json: - schema: *261 + schema: *263 examples: - default: *722 + default: *724 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108909,9 +109117,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *263 - - *264 - - *72 + - *265 + - *266 + - *74 responses: '204': description: Response @@ -108943,9 +109151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *263 - - *264 - - *72 + - *265 + - *266 + - *74 - name: token description: package token schema: @@ -108977,9 +109185,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *263 - - *264 - - *72 + - *265 + - *266 + - *74 responses: '200': description: Response @@ -108987,7 +109195,7 @@ paths: application/json: schema: type: array - items: *265 + items: *267 examples: default: value: @@ -109045,16 +109253,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *263 - - *264 + - *265 - *266 - - *72 + - *268 + - *74 responses: '200': description: Response content: application/json: - schema: *265 + schema: *267 examples: default: value: @@ -109089,10 +109297,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *263 - - *264 - - *72 + - *265 - *266 + - *74 + - *268 responses: '204': description: Response @@ -109124,10 +109332,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *263 - - *264 - - *72 + - *265 - *266 + - *74 + - *268 responses: '204': description: Response @@ -109151,7 +109359,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *72 + - *74 - name: q description: Limit results to projects of the specified type. in: query @@ -109168,11 +109376,11 @@ paths: application/json: schema: type: array - items: *277 + items: *279 examples: - default: *278 + default: *280 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -109192,18 +109400,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *279 - - *72 + - *281 + - *74 responses: '200': description: Response content: application/json: - schema: *277 + schema: *279 examples: - default: *278 + default: *280 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -109223,8 +109431,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *279 - - *72 + - *281 + - *74 - *17 - *47 - *48 @@ -109235,11 +109443,11 @@ paths: application/json: schema: type: array - items: *283 + items: *285 examples: - default: *723 + default: *725 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -109258,8 +109466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - - *72 - - *279 + - *74 + - *281 requestBody: required: true content: @@ -109297,7 +109505,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *724 + items: *726 required: - name - data_type @@ -109313,7 +109521,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *725 + iteration_configuration: *727 required: - name - data_type @@ -109335,20 +109543,20 @@ paths: value: name: Due date data_type: date - single_select_field: *726 - iteration_field: *727 + single_select_field: *728 + iteration_field: *729 responses: '201': description: Response content: application/json: - schema: *283 + schema: *285 examples: - text_field: *728 - number_field: *729 - date_field: *730 - single_select_field: *731 - iteration_field: *732 + text_field: *730 + number_field: *731 + date_field: *732 + single_select_field: *733 + iteration_field: *734 '304': *37 '403': *29 '401': *25 @@ -109369,19 +109577,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *279 - - *733 - - *72 + - *281 + - *735 + - *74 responses: '200': description: Response content: application/json: - schema: *283 + schema: *285 examples: - default: *734 + default: *736 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -109402,8 +109610,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *279 - - *72 + - *281 + - *74 - *47 - *48 - *17 @@ -109435,11 +109643,11 @@ paths: application/json: schema: type: array - items: *287 + items: *289 examples: - default: *288 + default: *290 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -109458,8 +109666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *72 - - *279 + - *74 + - *281 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -109529,22 +109737,22 @@ paths: description: Response content: application/json: - schema: *285 + schema: *287 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *286 + value: *288 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *286 + value: *288 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *286 + value: *288 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *286 + value: *288 '304': *37 '403': *29 '401': *25 @@ -109564,9 +109772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *279 - - *72 - - *289 + - *281 + - *74 + - *291 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -109586,11 +109794,11 @@ paths: description: Response content: application/json: - schema: *287 + schema: *289 examples: - default: *288 + default: *290 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -109609,9 +109817,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *279 - - *72 - - *289 + - *281 + - *74 + - *291 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -109681,13 +109889,13 @@ paths: description: Response content: application/json: - schema: *287 + schema: *289 examples: - text_field: *288 - number_field: *288 - date_field: *288 - single_select_field: *288 - iteration_field: *288 + text_field: *290 + number_field: *290 + date_field: *290 + single_select_field: *290 + iteration_field: *290 '401': *25 '403': *29 '404': *6 @@ -109707,9 +109915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *279 - - *72 - - *289 + - *281 + - *74 + - *291 responses: '204': description: Response @@ -109731,9 +109939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *279 - - *72 - - *735 + - *281 + - *74 + - *737 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -109759,11 +109967,11 @@ paths: application/json: schema: type: array - items: *287 + items: *289 examples: - default: *288 + default: *290 headers: - Link: *68 + Link: *70 '304': *37 '403': *29 '401': *25 @@ -109789,7 +109997,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -109799,7 +110007,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -109864,7 +110072,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -109874,7 +110082,7 @@ paths: application/json: schema: type: array - items: *112 + items: *114 examples: default: value: @@ -109937,7 +110145,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *72 + - *74 - name: type description: Limit results to repositories of the specified type. in: query @@ -109980,11 +110188,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110004,12 +110212,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - - *72 - - *122 + - *74 - *124 - - *123 - - *736 + - *126 - *125 + - *738 + - *127 responses: '200': description: Response when getting a billing premium request usage report @@ -110117,7 +110325,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110137,10 +110345,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - - *72 - - *122 - - *737 - - *123 + - *74 + - *124 + - *739 + - *125 responses: '200': description: Response when getting a billing usage report @@ -110211,7 +110419,7 @@ paths: '400': *14 '403': *29 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110234,13 +110442,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - - *72 - - *122 + - *74 - *124 - - *123 - - *738 + - *126 - *125 - - *739 + - *740 + - *127 + - *741 responses: '200': description: Response when getting a billing usage summary @@ -110346,7 +110554,7 @@ paths: '403': *29 '404': *6 '500': *55 - '503': *120 + '503': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110364,7 +110572,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -110374,11 +110582,11 @@ paths: application/json: schema: type: array - items: *707 + items: *709 examples: - default: *708 + default: *710 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110396,7 +110604,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -110406,11 +110614,11 @@ paths: application/json: schema: type: array - items: *709 + items: *711 examples: - default: *740 + default: *742 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110432,8 +110640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *72 - - *741 + - *74 + - *743 - *62 - *17 - *19 @@ -110445,13 +110653,13 @@ paths: schema: anyOf: - type: array - items: *742 + items: *744 - type: array - items: *80 + items: *82 examples: - default-response: *712 + default-response: *714 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110468,7 +110676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *72 + - *74 - *17 - *19 responses: @@ -110478,11 +110686,11 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *267 + default: *269 headers: - Link: *68 + Link: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110608,7 +110816,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &743 + enterprise: &745 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -110666,7 +110874,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &744 + installation: &746 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -110685,7 +110893,7 @@ x-webhooks: required: - id - node_id - organization: &745 + organization: &747 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -110745,13 +110953,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &746 + repository: &748 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &778 + properties: &780 id: description: Unique identifier of the repository example: 42 @@ -110771,8 +110979,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *89 - required: *90 + properties: *91 + required: *92 nullable: true organization: title: Simple User @@ -111446,7 +111654,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &779 + required: &781 - archive_url - assignees_url - blobs_url @@ -111520,7 +111728,7 @@ x-webhooks: - watchers_count - created_at - updated_at - x-github-breaking-changes: &780 + x-github-breaking-changes: &782 - changeset: remove_use_squash_pr_title_as_default patch: properties: @@ -111611,10 +111819,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -111690,11 +111898,11 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - rule: &747 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + rule: &749 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -111917,11 +112125,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - rule: *747 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + rule: *749 sender: *4 required: - action @@ -112104,11 +112312,11 @@ x-webhooks: - everyone required: - from - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - rule: *747 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + rule: *749 sender: *4 required: - action @@ -112192,7 +112400,7 @@ x-webhooks: type: string enum: - completed - check_run: &749 + check_run: &751 title: CheckRun description: A check performed on the code of a given code change type: object @@ -112245,8 +112453,8 @@ x-webhooks: type: string pull_requests: type: array - items: *91 - repository: *159 + items: *93 + repository: *161 status: example: completed type: string @@ -112283,7 +112491,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *748 + deployment: *750 details_url: example: https://example.com type: string @@ -112333,7 +112541,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *91 + items: *93 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -112368,10 +112576,10 @@ x-webhooks: - output - app - pull_requests - installation: *744 - enterprise: *743 - organization: *745 - repository: *746 + installation: *746 + enterprise: *745 + organization: *747 + repository: *748 sender: *4 required: - check_run @@ -112762,11 +112970,11 @@ x-webhooks: type: string enum: - created - check_run: *749 - installation: *744 - enterprise: *743 - organization: *745 - repository: *746 + check_run: *751 + installation: *746 + enterprise: *745 + organization: *747 + repository: *748 sender: *4 required: - check_run @@ -113160,11 +113368,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *749 - installation: *744 - enterprise: *743 - organization: *745 - repository: *746 + check_run: *751 + installation: *746 + enterprise: *745 + organization: *747 + repository: *748 requested_action: description: The action requested by the user. type: object @@ -113567,11 +113775,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *749 - installation: *744 - enterprise: *743 - organization: *745 - repository: *746 + check_run: *751 + installation: *746 + enterprise: *745 + organization: *747 + repository: *748 sender: *4 required: - check_run @@ -114541,10 +114749,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -115233,10 +115441,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -115919,10 +116127,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -116088,7 +116296,7 @@ x-webhooks: required: - login - id - dismissed_comment: *437 + dismissed_comment: *439 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116233,20 +116441,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &750 + commit_oid: &752 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *743 - installation: *744 - organization: *745 - ref: &751 + enterprise: *745 + installation: *746 + organization: *747 + ref: &753 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *746 + repository: *748 sender: *4 required: - action @@ -116411,7 +116619,7 @@ x-webhooks: required: - login - id - dismissed_comment: *437 + dismissed_comment: *439 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116641,12 +116849,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *750 - enterprise: *743 - installation: *744 - organization: *745 - ref: *751 - repository: *746 + commit_oid: *752 + enterprise: *745 + installation: *746 + organization: *747 + ref: *753 + repository: *748 sender: *4 required: - action @@ -116741,7 +116949,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *437 + dismissed_comment: *439 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116912,12 +117120,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *750 - enterprise: *743 - installation: *744 - organization: *745 - ref: *751 - repository: *746 + commit_oid: *752 + enterprise: *745 + installation: *746 + organization: *747 + ref: *753 + repository: *748 sender: *4 required: - action @@ -117083,7 +117291,7 @@ x-webhooks: required: - login - id - dismissed_comment: *437 + dismissed_comment: *439 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -117249,12 +117457,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *750 - enterprise: *743 - installation: *744 - organization: *745 - ref: *751 - repository: *746 + commit_oid: *752 + enterprise: *745 + installation: *746 + organization: *747 + ref: *753 + repository: *748 sender: *4 required: - action @@ -117353,7 +117561,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *437 + dismissed_comment: *439 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -117528,16 +117736,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *746 + repository: *748 sender: *4 required: - action @@ -117634,7 +117842,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *437 + dismissed_comment: *439 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -117774,12 +117982,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *750 - enterprise: *743 - installation: *744 - organization: *745 - ref: *751 - repository: *746 + commit_oid: *752 + enterprise: *745 + installation: *746 + organization: *747 + ref: *753 + repository: *748 sender: *4 required: - action @@ -117945,7 +118153,7 @@ x-webhooks: required: - login - id - dismissed_comment: *437 + dismissed_comment: *439 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -118090,10 +118298,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -118348,10 +118556,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -118431,18 +118639,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *745 - pusher_type: &752 + organization: *747 + pusher_type: &754 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &753 + ref: &755 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -118452,7 +118660,7 @@ x-webhooks: enum: - tag - branch - repository: *746 + repository: *748 sender: *4 required: - ref @@ -118534,10 +118742,10 @@ x-webhooks: type: string enum: - created - definition: *291 - enterprise: *743 - installation: *744 - organization: *745 + definition: *293 + enterprise: *745 + installation: *746 + organization: *747 sender: *4 required: - action @@ -118622,9 +118830,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 sender: *4 required: - action @@ -118701,10 +118909,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *291 - enterprise: *743 - installation: *744 - organization: *745 + definition: *293 + enterprise: *745 + installation: *746 + organization: *747 sender: *4 required: - action @@ -118781,10 +118989,10 @@ x-webhooks: type: string enum: - updated - definition: *291 - enterprise: *743 - installation: *744 - organization: *745 + definition: *293 + enterprise: *745 + installation: *746 + organization: *747 sender: *4 required: - action @@ -118861,19 +119069,19 @@ x-webhooks: type: string enum: - updated - enterprise: *743 - installation: *744 - repository: *746 - organization: *745 + enterprise: *745 + installation: *746 + repository: *748 + organization: *747 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *295 + items: *297 old_property_values: type: array description: The old custom property values for the repository. - items: *295 + items: *297 required: - action - repository @@ -118949,18 +119157,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *743 - installation: *744 - organization: *745 - pusher_type: *752 - ref: *753 + enterprise: *745 + installation: *746 + organization: *747 + pusher_type: *754 + ref: *755 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *746 + repository: *748 sender: *4 required: - ref @@ -119040,11 +119248,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *501 - installation: *744 - organization: *745 - enterprise: *743 - repository: *746 + alert: *503 + installation: *746 + organization: *747 + enterprise: *745 + repository: *748 sender: *4 required: - action @@ -119124,11 +119332,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *501 - installation: *744 - organization: *745 - enterprise: *743 - repository: *746 + alert: *503 + installation: *746 + organization: *747 + enterprise: *745 + repository: *748 sender: *4 required: - action @@ -119209,11 +119417,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *501 - installation: *744 - organization: *745 - enterprise: *743 - repository: *746 + alert: *503 + installation: *746 + organization: *747 + enterprise: *745 + repository: *748 sender: *4 required: - action @@ -119294,11 +119502,11 @@ x-webhooks: type: string enum: - created - alert: *501 - installation: *744 - organization: *745 - enterprise: *743 - repository: *746 + alert: *503 + installation: *746 + organization: *747 + enterprise: *745 + repository: *748 sender: *4 required: - action @@ -119377,11 +119585,11 @@ x-webhooks: type: string enum: - dismissed - alert: *501 - installation: *744 - organization: *745 - enterprise: *743 - repository: *746 + alert: *503 + installation: *746 + organization: *747 + enterprise: *745 + repository: *748 sender: *4 required: - action @@ -119460,11 +119668,11 @@ x-webhooks: type: string enum: - fixed - alert: *501 - installation: *744 - organization: *745 - enterprise: *743 - repository: *746 + alert: *503 + installation: *746 + organization: *747 + enterprise: *745 + repository: *748 sender: *4 required: - action @@ -119544,11 +119752,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *501 - installation: *744 - organization: *745 - enterprise: *743 - repository: *746 + alert: *503 + installation: *746 + organization: *747 + enterprise: *745 + repository: *748 sender: *4 required: - action @@ -119627,11 +119835,11 @@ x-webhooks: type: string enum: - reopened - alert: *501 - installation: *744 - organization: *745 - enterprise: *743 - repository: *746 + alert: *503 + installation: *746 + organization: *747 + enterprise: *745 + repository: *748 sender: *4 required: - action @@ -119708,9 +119916,9 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - key: &754 + enterprise: *745 + installation: *746 + key: &756 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -119746,8 +119954,8 @@ x-webhooks: - verified - created_at - read_only - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -119824,11 +120032,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - key: *754 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + key: *756 + organization: *747 + repository: *748 sender: *4 required: - action @@ -120384,12 +120592,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - workflow: &760 + workflow: &762 title: Workflow type: object nullable: true @@ -121130,15 +121338,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *755 - required: *756 + properties: *757 + required: *758 nullable: true pull_requests: type: array - items: *599 - repository: *746 - organization: *745 - installation: *744 + items: *601 + repository: *748 + organization: *747 + installation: *746 sender: *4 responses: '200': @@ -121209,7 +121417,7 @@ x-webhooks: type: string enum: - approved - approver: &757 + approver: &759 type: object properties: avatar_url: @@ -121252,11 +121460,11 @@ x-webhooks: type: string comment: type: string - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - reviewers: &758 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + reviewers: &760 type: array items: type: object @@ -121335,7 +121543,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &759 + workflow_job_run: &761 type: object properties: conclusion: @@ -122066,18 +122274,18 @@ x-webhooks: type: string enum: - rejected - approver: *757 + approver: *759 comment: type: string - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - reviewers: *758 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + reviewers: *760 sender: *4 since: type: string - workflow_job_run: *759 + workflow_job_run: *761 workflow_job_runs: type: array items: @@ -122781,13 +122989,13 @@ x-webhooks: type: string enum: - requested - enterprise: *743 + enterprise: *745 environment: type: string - installation: *744 - organization: *745 - repository: *746 - requestor: &765 + installation: *746 + organization: *747 + repository: *748 + requestor: &767 title: User type: object nullable: true @@ -124676,12 +124884,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Deployment Workflow Run type: object @@ -125361,7 +125569,7 @@ x-webhooks: type: string enum: - answered - answer: &763 + answer: &765 type: object properties: author_association: @@ -125518,11 +125726,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -125649,11 +125857,11 @@ x-webhooks: - from required: - category - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -125736,11 +125944,11 @@ x-webhooks: type: string enum: - closed - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -125822,7 +126030,7 @@ x-webhooks: type: string enum: - created - comment: &762 + comment: &764 type: object properties: author_association: @@ -125979,11 +126187,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126066,12 +126274,12 @@ x-webhooks: type: string enum: - deleted - comment: *762 - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + comment: *764 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126166,12 +126374,12 @@ x-webhooks: - from required: - body - comment: *762 - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + comment: *764 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126255,11 +126463,11 @@ x-webhooks: type: string enum: - created - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126341,11 +126549,11 @@ x-webhooks: type: string enum: - deleted - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126445,11 +126653,11 @@ x-webhooks: type: string required: - from - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126531,10 +126739,10 @@ x-webhooks: type: string enum: - labeled - discussion: *761 - enterprise: *743 - installation: *744 - label: &764 + discussion: *763 + enterprise: *745 + installation: *746 + label: &766 title: Label type: object properties: @@ -126566,8 +126774,8 @@ x-webhooks: - color - default - description - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126650,11 +126858,11 @@ x-webhooks: type: string enum: - locked - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126736,11 +126944,11 @@ x-webhooks: type: string enum: - pinned - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126822,11 +127030,11 @@ x-webhooks: type: string enum: - reopened - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -126911,16 +127119,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *761 - new_repository: *746 + new_discussion: *763 + new_repository: *748 required: - new_discussion - new_repository - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -127003,10 +127211,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *761 - old_answer: *763 - organization: *745 - repository: *746 + discussion: *763 + old_answer: *765 + organization: *747 + repository: *748 sender: *4 required: - action @@ -127088,12 +127296,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *761 - enterprise: *743 - installation: *744 - label: *764 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + label: *766 + organization: *747 + repository: *748 sender: *4 required: - action @@ -127176,11 +127384,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -127262,11 +127470,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *761 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + discussion: *763 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -127339,7 +127547,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *743 + enterprise: *745 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -127999,9 +128207,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *744 - organization: *745 - repository: *746 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - forkee @@ -128147,9 +128355,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 pages: description: The pages that were updated. type: array @@ -128186,7 +128394,7 @@ x-webhooks: - action - sha - html_url - repository: *746 + repository: *748 sender: *4 required: - pages @@ -128262,10 +128470,10 @@ x-webhooks: type: string enum: - created - enterprise: *743 + enterprise: *745 installation: *22 - organization: *745 - repositories: &766 + organization: *747 + repositories: &768 description: An array of repository objects that the installation can access. type: array @@ -128291,8 +128499,8 @@ x-webhooks: - name - full_name - private - repository: *746 - requester: *765 + repository: *748 + requester: *767 sender: *4 required: - action @@ -128367,11 +128575,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 + enterprise: *745 installation: *22 - organization: *745 - repositories: *766 - repository: *746 + organization: *747 + repositories: *768 + repository: *748 requester: nullable: true sender: *4 @@ -128447,11 +128655,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *743 + enterprise: *745 installation: *22 - organization: *745 - repositories: *766 - repository: *746 + organization: *747 + repositories: *768 + repository: *748 requester: nullable: true sender: *4 @@ -128527,10 +128735,10 @@ x-webhooks: type: string enum: - added - enterprise: *743 + enterprise: *745 installation: *22 - organization: *745 - repositories_added: &767 + organization: *747 + repositories_added: &769 description: An array of repository objects, which were added to the installation. type: array @@ -128576,15 +128784,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *746 - repository_selection: &768 + repository: *748 + repository_selection: &770 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *765 + requester: *767 sender: *4 required: - action @@ -128663,10 +128871,10 @@ x-webhooks: type: string enum: - removed - enterprise: *743 + enterprise: *745 installation: *22 - organization: *745 - repositories_added: *767 + organization: *747 + repositories_added: *769 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -128693,9 +128901,9 @@ x-webhooks: - name - full_name - private - repository: *746 - repository_selection: *768 - requester: *765 + repository: *748 + repository_selection: *770 + requester: *767 sender: *4 required: - action @@ -128774,11 +128982,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *743 + enterprise: *745 installation: *22 - organization: *745 - repositories: *766 - repository: *746 + organization: *747 + repositories: *768 + repository: *748 requester: nullable: true sender: *4 @@ -128956,10 +129164,10 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 target_type: type: string @@ -129038,11 +129246,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *743 + enterprise: *745 installation: *22 - organization: *745 - repositories: *766 - repository: *746 + organization: *747 + repositories: *768 + repository: *748 requester: nullable: true sender: *4 @@ -129166,8 +129374,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *81 - required: *82 + properties: *83 + required: *84 reactions: title: Reactions type: object @@ -129216,8 +129424,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *576 - required: *577 + properties: *578 + required: *579 nullable: true user: title: User @@ -129302,8 +129510,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -130092,8 +130300,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130109,7 +130317,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -130442,8 +130650,8 @@ x-webhooks: - state - locked - assignee - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -130523,7 +130731,7 @@ x-webhooks: type: string enum: - deleted - comment: &769 + comment: &771 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -130680,8 +130888,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *576 - required: *577 + properties: *578 + required: *579 nullable: true required: - url @@ -130696,8 +130904,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131482,8 +131690,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131499,7 +131707,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -131834,8 +132042,8 @@ x-webhooks: - state - locked - assignee - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -131915,7 +132123,7 @@ x-webhooks: type: string enum: - edited - changes: &799 + changes: &801 description: The changes to the comment. type: object properties: @@ -131927,9 +132135,9 @@ x-webhooks: type: string required: - from - comment: *769 - enterprise: *743 - installation: *744 + comment: *771 + enterprise: *745 + installation: *746 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -132717,8 +132925,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132734,7 +132942,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -133067,8 +133275,8 @@ x-webhooks: - state - locked - assignee - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -133149,9 +133357,9 @@ x-webhooks: type: string enum: - pinned - comment: *769 - enterprise: *743 - installation: *744 + comment: *771 + enterprise: *745 + installation: *746 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133941,8 +134149,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133958,7 +134166,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -134293,8 +134501,8 @@ x-webhooks: - state - locked - assignee - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -134374,9 +134582,9 @@ x-webhooks: type: string enum: - unpinned - comment: *769 - enterprise: *743 - installation: *744 + comment: *771 + enterprise: *745 + installation: *746 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135166,8 +135374,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135183,7 +135391,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -135518,8 +135726,8 @@ x-webhooks: - state - locked - assignee - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -135602,15 +135810,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 + blocked_issue: *88 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - blocking_issue_repo: *80 - installation: *744 - organization: *745 - repository: *746 + blocking_issue: *88 + blocking_issue_repo: *82 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -135693,15 +135901,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 + blocked_issue: *88 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - blocking_issue_repo: *80 - installation: *744 - organization: *745 - repository: *746 + blocking_issue: *88 + blocking_issue_repo: *82 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -135783,15 +135991,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 - blocked_issue_repo: *80 + blocked_issue: *88 + blocked_issue_repo: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - installation: *744 - organization: *745 - repository: *746 + blocking_issue: *88 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -135874,15 +136082,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *86 - blocked_issue_repo: *80 + blocked_issue: *88 + blocked_issue_repo: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *86 - installation: *744 - organization: *745 - repository: *746 + blocking_issue: *88 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -135962,9 +136170,9 @@ x-webhooks: type: string enum: - assigned - assignee: *765 - enterprise: *743 - installation: *744 + assignee: *767 + enterprise: *745 + installation: *746 issue: &772 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136754,14 +136962,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136777,7 +136985,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -136878,8 +137086,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -136959,8 +137167,8 @@ x-webhooks: type: string enum: - closed - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -137754,14 +137962,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137777,7 +137985,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -138013,8 +138221,8 @@ x-webhooks: required: - state - closed_at - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -138093,8 +138301,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138879,14 +139087,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138902,7 +139110,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -139002,8 +139210,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -139082,8 +139290,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139890,14 +140098,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139913,7 +140121,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -139992,7 +140200,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &770 + milestone: &773 title: Milestone description: A collection of related issues and pull requests. type: object @@ -140130,8 +140338,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -140230,8 +140438,8 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141020,14 +141228,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141040,7 +141248,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *243 + type: *245 title: description: Title of the issue type: string @@ -141144,9 +141352,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *764 - organization: *745 - repository: *746 + label: *766 + organization: *747 + repository: *748 sender: *4 required: - action @@ -141166,6 +141374,339 @@ x-webhooks: - repository - organization - app + issues-field-added: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue field value was set or updated on an issue. + operationId: issues/field-added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issues field_added event + type: object + properties: + action: + type: string + enum: + - field_added + enterprise: *745 + installation: *746 + issue: *772 + issue_field: + type: object + description: The issue field whose value was set or updated on the + issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was set or updated for the issue field. + When updating an existing value, the previous value is available + in `changes`. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present + for single_select field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + changes: + type: object + description: The previous field value, present when an existing + value was updated. + properties: + issue_field_value: + type: object + description: The previous issue field value data. + properties: + from: + type: object + description: The previous value of the issue field before + the update. + properties: + id: + type: integer + description: The unique identifier of the issue field + value. + value: + description: The previous value. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the previously selected + option. Present for single_select field types. + option: + type: object + description: The previously selected option details. + Present for single_select field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + required: + - from + organization: *747 + repository: *748 + sender: *4 + required: + - action + - issue + - issue_field + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-field-removed: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue field value was cleared from an issue. + operationId: issues/field-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issues field_removed event + type: object + properties: + action: + type: string + enum: + - field_removed + enterprise: *745 + installation: *746 + issue: *772 + issue_field: + type: object + description: The issue field whose value was cleared from the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was cleared from the issue field. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present + for single_select field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + organization: *747 + repository: *748 + sender: *4 + required: + - action + - issue + - issue_field + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app issues-labeled: post: summary: |- @@ -141226,8 +141767,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142015,14 +142556,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142035,7 +142576,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *243 + type: *245 title: description: Title of the issue type: string @@ -142139,9 +142680,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *764 - organization: *745 - repository: *746 + label: *766 + organization: *747 + repository: *748 sender: *4 required: - action @@ -142221,8 +142762,8 @@ x-webhooks: type: string enum: - locked - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143034,14 +143575,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143054,7 +143595,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *243 + type: *245 title: description: Title of the issue type: string @@ -143135,8 +143676,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -143215,8 +143756,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144022,14 +144563,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144045,7 +144586,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -144123,9 +144664,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *770 - organization: *745 - repository: *746 + milestone: *773 + organization: *747 + repository: *748 sender: *4 required: - action @@ -144988,11 +145529,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145020,8 +145561,8 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true user: title: User @@ -145093,7 +145634,7 @@ x-webhooks: required: - login - id - type: *243 + type: *245 required: - id - number @@ -145573,8 +146114,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146358,11 +146899,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146378,7 +146919,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -146391,8 +146932,8 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true user: title: User @@ -146486,8 +147027,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -146567,9 +147108,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *743 - installation: *744 - issue: &771 + enterprise: *745 + installation: *746 + issue: &774 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -147352,14 +147893,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147375,7 +147916,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -147475,8 +148016,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -147555,8 +148096,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148366,14 +148907,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148467,9 +149008,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *243 - organization: *745 - repository: *746 + type: *245 + organization: *747 + repository: *748 sender: *4 required: - action @@ -149335,14 +149876,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149358,7 +149899,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -149937,11 +150478,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *743 - installation: *744 - issue: *771 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + issue: *774 + organization: *747 + repository: *748 sender: *4 required: - action @@ -150021,12 +150562,12 @@ x-webhooks: type: string enum: - typed - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: *772 - type: *243 - organization: *745 - repository: *746 + type: *245 + organization: *747 + repository: *748 sender: *4 required: - action @@ -150107,7 +150648,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &802 + assignee: &804 title: User type: object nullable: true @@ -150177,11 +150718,11 @@ x-webhooks: required: - login - id - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: *772 - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -150260,12 +150801,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: *772 - label: *764 - organization: *745 - repository: *746 + label: *766 + organization: *747 + repository: *748 sender: *4 required: - action @@ -150345,8 +150886,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151156,14 +151697,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *87 - required: *88 + properties: *89 + required: *90 nullable: true - sub_issues_summary: *679 - issue_dependencies_summary: *680 + sub_issues_summary: *681 + issue_dependencies_summary: *682 issue_field_values: type: array - items: *560 + items: *562 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151179,7 +151720,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *245 updated_at: type: string format: date-time @@ -151257,8 +151798,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -151338,11 +151879,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *743 - installation: *744 - issue: *771 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + issue: *774 + organization: *747 + repository: *748 sender: *4 required: - action @@ -151421,12 +151962,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 issue: *772 - type: *243 - organization: *745 - repository: *746 + type: *245 + organization: *747 + repository: *748 sender: *4 required: - action @@ -151506,11 +152047,11 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - label: *764 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + label: *766 + organization: *747 + repository: *748 sender: *4 required: - action @@ -151588,11 +152129,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - label: *764 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + label: *766 + organization: *747 + repository: *748 sender: *4 required: - action @@ -151702,11 +152243,11 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 - label: *764 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + label: *766 + organization: *747 + repository: *748 sender: *4 required: - action @@ -151788,9 +152329,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *743 - installation: *744 - marketplace_purchase: &773 + enterprise: *745 + installation: *746 + marketplace_purchase: &775 title: Marketplace Purchase type: object required: @@ -151873,8 +152414,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *745 - previous_marketplace_purchase: &774 + organization: *747 + previous_marketplace_purchase: &776 title: Marketplace Purchase type: object properties: @@ -151954,7 +152495,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *746 + repository: *748 sender: *4 required: - action @@ -152034,10 +152575,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *743 - installation: *744 - marketplace_purchase: *773 - organization: *745 + enterprise: *745 + installation: *746 + marketplace_purchase: *775 + organization: *747 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -152120,7 +152661,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *746 + repository: *748 sender: *4 required: - action @@ -152202,10 +152743,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *743 - installation: *744 - marketplace_purchase: *773 - organization: *745 + enterprise: *745 + installation: *746 + marketplace_purchase: *775 + organization: *747 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -152287,7 +152828,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *746 + repository: *748 sender: *4 required: - action @@ -152368,8 +152909,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 marketplace_purchase: title: Marketplace Purchase type: object @@ -152451,9 +152992,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *745 - previous_marketplace_purchase: *774 - repository: *746 + organization: *747 + previous_marketplace_purchase: *776 + repository: *748 sender: *4 required: - action @@ -152533,12 +153074,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *743 - installation: *744 - marketplace_purchase: *773 - organization: *745 - previous_marketplace_purchase: *774 - repository: *746 + enterprise: *745 + installation: *746 + marketplace_purchase: *775 + organization: *747 + previous_marketplace_purchase: *776 + repository: *748 sender: *4 required: - action @@ -152640,11 +153181,11 @@ x-webhooks: type: string required: - to - enterprise: *743 - installation: *744 - member: *765 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + member: *767 + organization: *747 + repository: *748 sender: *4 required: - action @@ -152744,11 +153285,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *743 - installation: *744 - member: *765 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + member: *767 + organization: *747 + repository: *748 sender: *4 required: - action @@ -152827,11 +153368,11 @@ x-webhooks: type: string enum: - removed - enterprise: *743 - installation: *744 - member: *765 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + member: *767 + organization: *747 + repository: *748 sender: *4 required: - action @@ -152909,11 +153450,11 @@ x-webhooks: type: string enum: - added - enterprise: *743 - installation: *744 - member: *765 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + member: *767 + organization: *747 + repository: *748 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152989,7 +153530,7 @@ x-webhooks: required: - login - id - team: &775 + team: &777 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -153212,11 +153753,11 @@ x-webhooks: type: string enum: - removed - enterprise: *743 - installation: *744 - member: *765 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + member: *767 + organization: *747 + repository: *748 scope: description: The scope of the membership. Currently, can only be `team`. @@ -153293,7 +153834,7 @@ x-webhooks: required: - login - id - team: *775 + team: *777 required: - action - scope @@ -153375,8 +153916,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *744 - merge_group: &777 + installation: *746 + merge_group: &779 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -153395,15 +153936,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *776 + head_commit: *778 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -153489,10 +154030,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *744 - merge_group: *777 - organization: *745 - repository: *746 + installation: *746 + merge_group: *779 + organization: *747 + repository: *748 sender: *4 required: - action @@ -153565,7 +154106,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 + enterprise: *745 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -153674,17 +154215,17 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *744 - organization: *745 + installation: *746 + organization: *747 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *778 - required: *779 - x-github-breaking-changes: *780 + properties: *780 + required: *781 + x-github-breaking-changes: *782 nullable: true sender: *4 required: @@ -153765,11 +154306,11 @@ x-webhooks: type: string enum: - closed - enterprise: *743 - installation: *744 - milestone: *770 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + milestone: *773 + organization: *747 + repository: *748 sender: *4 required: - action @@ -153848,9 +154389,9 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - milestone: &781 + enterprise: *745 + installation: *746 + milestone: &783 title: Milestone description: A collection of related issues and pull requests. type: object @@ -153987,8 +154528,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -154067,11 +154608,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - milestone: *770 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + milestone: *773 + organization: *747 + repository: *748 sender: *4 required: - action @@ -154181,11 +154722,11 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 - milestone: *770 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + milestone: *773 + organization: *747 + repository: *748 sender: *4 required: - action @@ -154265,11 +154806,11 @@ x-webhooks: type: string enum: - opened - enterprise: *743 - installation: *744 - milestone: *781 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + milestone: *783 + organization: *747 + repository: *748 sender: *4 required: - action @@ -154348,11 +154889,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *765 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + blocked_user: *767 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -154431,11 +154972,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *765 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + blocked_user: *767 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -154514,9 +155055,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - membership: &782 + enterprise: *745 + installation: *746 + membership: &784 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -154623,8 +155164,8 @@ x-webhooks: - role - organization_url - user - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -154702,11 +155243,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *743 - installation: *744 - membership: *782 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + membership: *784 + organization: *747 + repository: *748 sender: *4 required: - action @@ -154785,8 +155326,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -154902,10 +155443,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 - user: *765 + user: *767 required: - action - invitation @@ -154983,11 +155524,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *743 - installation: *744 - membership: *782 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + membership: *784 + organization: *747 + repository: *748 sender: *4 required: - action @@ -155074,11 +155615,11 @@ x-webhooks: properties: from: type: string - enterprise: *743 - installation: *744 - membership: *782 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + membership: *784 + organization: *747 + repository: *748 sender: *4 required: - action @@ -155155,9 +155696,9 @@ x-webhooks: type: string enum: - published - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 package: description: Information about the package. type: object @@ -155656,7 +156197,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &783 + items: &785 title: Ruby Gems metadata type: object properties: @@ -155751,7 +156292,7 @@ x-webhooks: - owner - package_version - registry - repository: *746 + repository: *748 sender: *4 required: - action @@ -155827,9 +156368,9 @@ x-webhooks: type: string enum: - updated - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 package: description: Information about the package. type: object @@ -156182,7 +156723,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *783 + items: *785 source_url: type: string format: uri @@ -156252,7 +156793,7 @@ x-webhooks: - owner - package_version - registry - repository: *746 + repository: *748 sender: *4 required: - action @@ -156428,12 +156969,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *743 + enterprise: *745 id: type: integer - installation: *744 - organization: *745 - repository: *746 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - id @@ -156510,7 +157051,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &784 + personal_access_token_request: &786 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -156656,10 +157197,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *743 - organization: *745 + enterprise: *745 + organization: *747 sender: *4 - installation: *744 + installation: *746 required: - action - personal_access_token_request @@ -156736,11 +157277,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *784 - enterprise: *743 - organization: *745 + personal_access_token_request: *786 + enterprise: *745 + organization: *747 sender: *4 - installation: *744 + installation: *746 required: - action - personal_access_token_request @@ -156816,11 +157357,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *784 - enterprise: *743 - organization: *745 + personal_access_token_request: *786 + enterprise: *745 + organization: *747 sender: *4 - installation: *744 + installation: *746 required: - action - personal_access_token_request @@ -156895,11 +157436,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *784 - organization: *745 - enterprise: *743 + personal_access_token_request: *786 + organization: *747 + enterprise: *745 sender: *4 - installation: *744 + installation: *746 required: - action - personal_access_token_request @@ -157004,7 +157545,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *785 + last_response: *787 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -157036,8 +157577,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 zen: description: Random string of GitHub zen. @@ -157282,10 +157823,10 @@ x-webhooks: - from required: - note - enterprise: *743 - installation: *744 - organization: *745 - project_card: &786 + enterprise: *745 + installation: *746 + organization: *747 + project_card: &788 title: Project Card type: object properties: @@ -157404,7 +157945,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *746 + repository: *748 sender: *4 required: - action @@ -157485,11 +158026,11 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - project_card: *786 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + project_card: *788 + repository: *748 sender: *4 required: - action @@ -157569,9 +158110,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 project_card: title: Project Card type: object @@ -157699,9 +158240,9 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *778 - required: *779 - x-github-breaking-changes: *780 + properties: *780 + required: *781 + x-github-breaking-changes: *782 nullable: true sender: *4 required: @@ -157795,11 +158336,11 @@ x-webhooks: - from required: - note - enterprise: *743 - installation: *744 - organization: *745 - project_card: *786 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + project_card: *788 + repository: *748 sender: *4 required: - action @@ -157893,9 +158434,9 @@ x-webhooks: - from required: - column_id - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 project_card: allOf: - title: Project Card @@ -158085,7 +158626,7 @@ x-webhooks: type: string required: - after_id - repository: *746 + repository: *748 sender: *4 required: - action @@ -158165,10 +158706,10 @@ x-webhooks: type: string enum: - closed - enterprise: *743 - installation: *744 - organization: *745 - project: &788 + enterprise: *745 + installation: *746 + organization: *747 + project: &790 title: Project type: object properties: @@ -158292,7 +158833,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *746 + repository: *748 sender: *4 required: - action @@ -158372,10 +158913,10 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - project_column: &787 + enterprise: *745 + installation: *746 + organization: *747 + project_column: &789 title: Project Column type: object properties: @@ -158414,7 +158955,7 @@ x-webhooks: - name - created_at - updated_at - repository: *746 + repository: *748 sender: *4 required: - action @@ -158493,19 +159034,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 - project_column: *787 + enterprise: *745 + installation: *746 + organization: *747 + project_column: *789 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *778 - required: *779 - x-github-breaking-changes: *780 + properties: *780 + required: *781 + x-github-breaking-changes: *782 nullable: true sender: *4 required: @@ -158595,11 +159136,11 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 - organization: *745 - project_column: *787 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + project_column: *789 + repository: *748 sender: *4 required: - action @@ -158679,11 +159220,11 @@ x-webhooks: type: string enum: - moved - enterprise: *743 - installation: *744 - organization: *745 - project_column: *787 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + project_column: *789 + repository: *748 sender: *4 required: - action @@ -158763,11 +159304,11 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - project: *788 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + project: *790 + repository: *748 sender: *4 required: - action @@ -158847,19 +159388,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 - project: *788 + enterprise: *745 + installation: *746 + organization: *747 + project: *790 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *778 - required: *779 - x-github-breaking-changes: *780 + properties: *780 + required: *781 + x-github-breaking-changes: *782 nullable: true sender: *4 required: @@ -158961,11 +159502,11 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 - organization: *745 - project: *788 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + project: *790 + repository: *748 sender: *4 required: - action @@ -159044,11 +159585,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *743 - installation: *744 - organization: *745 - project: *788 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + project: *790 + repository: *748 sender: *4 required: - action @@ -159129,9 +159670,9 @@ x-webhooks: type: string enum: - closed - installation: *744 - organization: *745 - projects_v2: *277 + installation: *746 + organization: *747 + projects_v2: *279 sender: *4 required: - action @@ -159212,9 +159753,9 @@ x-webhooks: type: string enum: - created - installation: *744 - organization: *745 - projects_v2: *277 + installation: *746 + organization: *747 + projects_v2: *279 sender: *4 required: - action @@ -159295,9 +159836,9 @@ x-webhooks: type: string enum: - deleted - installation: *744 - organization: *745 - projects_v2: *277 + installation: *746 + organization: *747 + projects_v2: *279 sender: *4 required: - action @@ -159414,9 +159955,9 @@ x-webhooks: type: string to: type: string - installation: *744 - organization: *745 - projects_v2: *277 + installation: *746 + organization: *747 + projects_v2: *279 sender: *4 required: - action @@ -159499,7 +160040,7 @@ x-webhooks: type: string enum: - archived - changes: &792 + changes: &794 type: object properties: archived_at: @@ -159513,9 +160054,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *744 - organization: *745 - projects_v2_item: &789 + installation: *746 + organization: *747 + projects_v2_item: &791 title: Projects v2 Item description: An item belonging to a project type: object @@ -159533,7 +160074,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *284 + content_type: *286 creator: *4 created_at: type: string @@ -159650,9 +160191,9 @@ x-webhooks: nullable: true to: type: string - installation: *744 - organization: *745 - projects_v2_item: *789 + installation: *746 + organization: *747 + projects_v2_item: *791 sender: *4 required: - action @@ -159734,9 +160275,9 @@ x-webhooks: type: string enum: - created - installation: *744 - organization: *745 - projects_v2_item: *789 + installation: *746 + organization: *747 + projects_v2_item: *791 sender: *4 required: - action @@ -159817,9 +160358,9 @@ x-webhooks: type: string enum: - deleted - installation: *744 - organization: *745 - projects_v2_item: *789 + installation: *746 + organization: *747 + projects_v2_item: *791 sender: *4 required: - action @@ -159925,7 +160466,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &790 + - &792 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -159947,7 +160488,7 @@ x-webhooks: required: - id - name - - &791 + - &793 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -159981,8 +160522,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *790 - - *791 + - *792 + - *793 required: - field_value - type: object @@ -159998,9 +160539,9 @@ x-webhooks: nullable: true required: - body - installation: *744 - organization: *745 - projects_v2_item: *789 + installation: *746 + organization: *747 + projects_v2_item: *791 sender: *4 required: - action @@ -160095,9 +160636,9 @@ x-webhooks: to: type: string nullable: true - installation: *744 - organization: *745 - projects_v2_item: *789 + installation: *746 + organization: *747 + projects_v2_item: *791 sender: *4 required: - action @@ -160180,10 +160721,10 @@ x-webhooks: type: string enum: - restored - changes: *792 - installation: *744 - organization: *745 - projects_v2_item: *789 + changes: *794 + installation: *746 + organization: *747 + projects_v2_item: *791 sender: *4 required: - action @@ -160265,9 +160806,9 @@ x-webhooks: type: string enum: - reopened - installation: *744 - organization: *745 - projects_v2: *277 + installation: *746 + organization: *747 + projects_v2: *279 sender: *4 required: - action @@ -160348,14 +160889,14 @@ x-webhooks: type: string enum: - created - installation: *744 - organization: *745 - projects_v2_status_update: &795 + installation: *746 + organization: *747 + projects_v2_status_update: &797 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *793 - required: *794 + properties: *795 + required: *796 sender: *4 required: - action @@ -160436,9 +160977,9 @@ x-webhooks: type: string enum: - deleted - installation: *744 - organization: *745 - projects_v2_status_update: *795 + installation: *746 + organization: *747 + projects_v2_status_update: *797 sender: *4 required: - action @@ -160574,9 +161115,9 @@ x-webhooks: type: string format: date nullable: true - installation: *744 - organization: *745 - projects_v2_status_update: *795 + installation: *746 + organization: *747 + projects_v2_status_update: *797 sender: *4 required: - action @@ -160647,10 +161188,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - repository @@ -160727,13 +161268,13 @@ x-webhooks: type: string enum: - assigned - assignee: *765 - enterprise: *743 - installation: *744 - number: &796 + assignee: *767 + enterprise: *745 + installation: *746 + number: &798 description: The pull request number. type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -163038,7 +163579,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 sender: *4 required: - action @@ -163135,11 +163676,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 number: type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -165439,7 +165980,7 @@ x-webhooks: - draft reason: type: string - repository: *746 + repository: *748 sender: *4 required: - action @@ -165536,11 +166077,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 number: type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -167840,7 +168381,7 @@ x-webhooks: - draft reason: type: string - repository: *746 + repository: *748 sender: *4 required: - action @@ -167937,13 +168478,13 @@ x-webhooks: type: string enum: - closed - enterprise: *743 - installation: *744 - number: *796 - organization: *745 - pull_request: &797 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 + pull_request: &799 allOf: - - *599 + - *601 - type: object properties: allow_auto_merge: @@ -168005,7 +168546,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *746 + repository: *748 sender: *4 required: - action @@ -168086,12 +168627,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *743 - installation: *744 - number: *796 - organization: *745 - pull_request: *797 - repository: *746 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 + pull_request: *799 + repository: *748 sender: *4 required: - action @@ -168171,11 +168712,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *743 - milestone: *583 - number: *796 - organization: *745 - pull_request: &798 + enterprise: *745 + milestone: *585 + number: *798 + organization: *747 + pull_request: &800 title: Pull Request type: object properties: @@ -170502,7 +171043,7 @@ x-webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *746 + repository: *748 sender: *4 required: - action @@ -170581,11 +171122,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 number: type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -172889,7 +173430,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *746 + repository: *748 sender: *4 required: - action @@ -173021,12 +173562,12 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 - number: *796 - organization: *745 - pull_request: *797 - repository: *746 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 + pull_request: *799 + repository: *748 sender: *4 required: - action @@ -173106,11 +173647,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 number: type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -175399,7 +175940,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 sender: *4 required: - action @@ -175487,11 +176028,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *743 - installation: *744 - label: *764 - number: *796 - organization: *745 + enterprise: *745 + installation: *746 + label: *766 + number: *798 + organization: *747 pull_request: title: Pull Request type: object @@ -177795,7 +178336,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 sender: *4 required: - action @@ -177891,10 +178432,10 @@ x-webhooks: type: string enum: - locked - enterprise: *743 - installation: *744 - number: *796 - organization: *745 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 pull_request: title: Pull Request type: object @@ -180196,7 +180737,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 sender: *4 required: - action @@ -180291,12 +180832,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *743 - milestone: *583 - number: *796 - organization: *745 - pull_request: *798 - repository: *746 + enterprise: *745 + milestone: *585 + number: *798 + organization: *747 + pull_request: *800 + repository: *748 sender: *4 required: - action @@ -180375,12 +180916,12 @@ x-webhooks: type: string enum: - opened - enterprise: *743 - installation: *744 - number: *796 - organization: *745 - pull_request: *797 - repository: *746 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 + pull_request: *799 + repository: *748 sender: *4 required: - action @@ -180461,12 +181002,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *743 - installation: *744 - number: *796 - organization: *745 - pull_request: *797 - repository: *746 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 + pull_request: *799 + repository: *748 sender: *4 required: - action @@ -180546,12 +181087,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *743 - installation: *744 - number: *796 - organization: *745 - pull_request: *797 - repository: *746 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 + pull_request: *799 + repository: *748 sender: *4 required: - action @@ -180917,9 +181458,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 pull_request: type: object properties: @@ -183111,7 +183652,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *746 + repository: *748 sender: *4 required: - action @@ -183206,7 +183747,7 @@ x-webhooks: type: string enum: - deleted - comment: &800 + comment: &802 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -183491,9 +184032,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 pull_request: type: object properties: @@ -185673,7 +186214,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *746 + repository: *748 sender: *4 required: - action @@ -185768,11 +186309,11 @@ x-webhooks: type: string enum: - edited - changes: *799 - comment: *800 - enterprise: *743 - installation: *744 - organization: *745 + changes: *801 + comment: *802 + enterprise: *745 + installation: *746 + organization: *747 pull_request: type: object properties: @@ -187955,7 +188496,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *746 + repository: *748 sender: *4 required: - action @@ -188051,9 +188592,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 pull_request: title: Simple Pull Request type: object @@ -190248,7 +190789,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *746 + repository: *748 review: description: The review that was affected. type: object @@ -190510,9 +191051,9 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 pull_request: title: Simple Pull Request type: object @@ -192566,8 +193107,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *746 - review: &801 + repository: *748 + review: &803 description: The review that was affected. type: object properties: @@ -192808,12 +193349,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 number: description: The pull request number. type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -195118,7 +195659,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 requested_reviewer: title: User type: object @@ -195202,12 +195743,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 number: description: The pull request number. type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -197519,7 +198060,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 requested_team: title: Team description: Groups of organization members that gives permissions @@ -197734,12 +198275,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 number: description: The pull request number. type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -200046,7 +200587,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 requested_reviewer: title: User type: object @@ -200131,12 +200672,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *743 - installation: *744 + enterprise: *745 + installation: *746 number: description: The pull request number. type: integer - organization: *745 + organization: *747 pull_request: title: Pull Request type: object @@ -202434,7 +202975,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 requested_team: title: Team description: Groups of organization members that gives permissions @@ -202638,9 +203179,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 pull_request: title: Simple Pull Request type: object @@ -204837,8 +205378,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *746 - review: *801 + repository: *748 + review: *803 sender: *4 required: - action @@ -204933,9 +205474,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 pull_request: title: Simple Pull Request type: object @@ -207027,7 +207568,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *746 + repository: *748 sender: *4 thread: type: object @@ -207422,9 +207963,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 pull_request: title: Simple Pull Request type: object @@ -209502,7 +210043,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *746 + repository: *748 sender: *4 thread: type: object @@ -209900,10 +210441,10 @@ x-webhooks: type: string before: type: string - enterprise: *743 - installation: *744 - number: *796 - organization: *745 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 pull_request: title: Pull Request type: object @@ -212196,7 +212737,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 sender: *4 required: - action @@ -212293,11 +212834,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *802 - enterprise: *743 - installation: *744 - number: *796 - organization: *745 + assignee: *804 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 pull_request: title: Pull Request type: object @@ -214602,7 +215143,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 sender: *4 required: - action @@ -214696,11 +215237,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *743 - installation: *744 - label: *764 - number: *796 - organization: *745 + enterprise: *745 + installation: *746 + label: *766 + number: *798 + organization: *747 pull_request: title: Pull Request type: object @@ -216995,7 +217536,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 sender: *4 required: - action @@ -217091,10 +217632,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *743 - installation: *744 - number: *796 - organization: *745 + enterprise: *745 + installation: *746 + number: *798 + organization: *747 pull_request: title: Pull Request type: object @@ -219381,7 +219922,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *746 + repository: *748 sender: *4 required: - action @@ -219596,7 +220137,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *743 + enterprise: *745 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -219688,8 +220229,8 @@ x-webhooks: - url - author - committer - installation: *744 - organization: *745 + installation: *746 + organization: *747 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -220275,9 +220816,9 @@ x-webhooks: type: string enum: - published - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 registry_package: type: object properties: @@ -220723,7 +221264,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *783 + items: *785 summary: type: string tag_name: @@ -220777,7 +221318,7 @@ x-webhooks: - owner - package_version - registry - repository: *746 + repository: *748 sender: *4 required: - action @@ -220855,9 +221396,9 @@ x-webhooks: type: string enum: - updated - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 registry_package: type: object properties: @@ -221165,7 +221706,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *783 + items: *785 summary: type: string tag_name: @@ -221214,7 +221755,7 @@ x-webhooks: - owner - package_version - registry - repository: *746 + repository: *748 sender: *4 required: - action @@ -221291,10 +221832,10 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - release: &803 + enterprise: *745 + installation: *746 + organization: *747 + release: &805 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -221612,7 +222153,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *746 + repository: *748 sender: *4 required: - action @@ -221689,11 +222230,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 - release: *803 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + release: *805 + repository: *748 sender: *4 required: - action @@ -221810,11 +222351,11 @@ x-webhooks: type: boolean required: - to - enterprise: *743 - installation: *744 - organization: *745 - release: *803 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + release: *805 + repository: *748 sender: *4 required: - action @@ -221892,9 +222433,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -222216,7 +222757,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *746 + repository: *748 sender: *4 required: - action @@ -222292,10 +222833,10 @@ x-webhooks: type: string enum: - published - enterprise: *743 - installation: *744 - organization: *745 - release: &804 + enterprise: *745 + installation: *746 + organization: *747 + release: &806 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -222614,7 +223155,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *746 + repository: *748 sender: *4 required: - action @@ -222690,11 +223231,11 @@ x-webhooks: type: string enum: - released - enterprise: *743 - installation: *744 - organization: *745 - release: *803 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + release: *805 + repository: *748 sender: *4 required: - action @@ -222770,11 +223311,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *743 - installation: *744 - organization: *745 - release: *804 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + release: *806 + repository: *748 sender: *4 required: - action @@ -222850,11 +223391,11 @@ x-webhooks: type: string enum: - published - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - repository_advisory: *666 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + repository_advisory: *668 sender: *4 required: - action @@ -222930,11 +223471,11 @@ x-webhooks: type: string enum: - reported - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - repository_advisory: *666 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + repository_advisory: *668 sender: *4 required: - action @@ -223010,10 +223551,10 @@ x-webhooks: type: string enum: - archived - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -223090,10 +223631,10 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -223171,10 +223712,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -223258,10 +223799,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -223373,10 +223914,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -223448,10 +223989,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 status: type: string @@ -223532,10 +224073,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -223612,10 +224153,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -223709,10 +224250,10 @@ x-webhooks: - name required: - repository - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -223792,11 +224333,11 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - repository_ruleset: *326 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + repository_ruleset: *328 sender: *4 required: - action @@ -223874,11 +224415,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - repository_ruleset: *326 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + repository_ruleset: *328 sender: *4 required: - action @@ -223956,11 +224497,11 @@ x-webhooks: type: string enum: - edited - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - repository_ruleset: *326 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + repository_ruleset: *328 changes: type: object properties: @@ -223979,16 +224520,16 @@ x-webhooks: properties: added: type: array - items: *300 + items: *302 deleted: type: array - items: *300 + items: *302 updated: type: array items: type: object properties: - condition: *300 + condition: *302 changes: type: object properties: @@ -224021,16 +224562,16 @@ x-webhooks: properties: added: type: array - items: *619 + items: *621 deleted: type: array - items: *619 + items: *621 updated: type: array items: type: object properties: - rule: *619 + rule: *621 changes: type: object properties: @@ -224264,10 +224805,10 @@ x-webhooks: - from required: - owner - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -224345,10 +224886,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -224426,7 +224967,7 @@ x-webhooks: type: string enum: - create - alert: &805 + alert: &807 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -224548,10 +225089,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -224757,10 +225298,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -224838,11 +225379,11 @@ x-webhooks: type: string enum: - reopen - alert: *805 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + alert: *807 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -225041,10 +225582,10 @@ x-webhooks: enum: - fixed - open - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -225122,11 +225663,11 @@ x-webhooks: type: string enum: - assigned - alert: &806 + alert: &808 type: object properties: - number: *177 - created_at: *178 + number: *179 + created_at: *180 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -225134,8 +225675,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *180 - html_url: *181 + url: *182 + html_url: *183 locations_url: type: string format: uri @@ -225265,10 +225806,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -225346,11 +225887,11 @@ x-webhooks: type: string enum: - created - alert: *806 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + alert: *808 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -225431,11 +225972,11 @@ x-webhooks: type: string enum: - created - alert: *806 - installation: *744 - location: *807 - organization: *745 - repository: *746 + alert: *808 + installation: *746 + location: *809 + organization: *747 + repository: *748 sender: *4 required: - location @@ -225673,11 +226214,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *806 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + alert: *808 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -225755,11 +226296,11 @@ x-webhooks: type: string enum: - reopened - alert: *806 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + alert: *808 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -225837,11 +226378,11 @@ x-webhooks: type: string enum: - resolved - alert: *806 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + alert: *808 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -225919,12 +226460,12 @@ x-webhooks: type: string enum: - unassigned - alert: *806 + alert: *808 assignee: *4 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -226002,11 +226543,11 @@ x-webhooks: type: string enum: - validated - alert: *806 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + alert: *808 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -226132,10 +226673,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *746 - enterprise: *743 - installation: *744 - organization: *745 + repository: *748 + enterprise: *745 + installation: *746 + organization: *747 sender: *4 required: - action @@ -226213,11 +226754,11 @@ x-webhooks: type: string enum: - published - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - security_advisory: &808 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + security_advisory: &810 description: The details of the security advisory, including summary, description, and severity. type: object @@ -226418,11 +226959,11 @@ x-webhooks: type: string enum: - updated - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 - security_advisory: *808 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 + security_advisory: *810 sender: *4 required: - action @@ -226495,10 +227036,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -226690,11 +227231,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *299 - enterprise: *743 - installation: *744 - organization: *745 - repository: *347 + security_and_analysis: *301 + enterprise: *745 + installation: *746 + organization: *747 + repository: *349 sender: *4 required: - changes @@ -226772,12 +227313,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - sponsorship: &809 + sponsorship: &811 type: object properties: created_at: @@ -227078,12 +227619,12 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - sponsorship: *809 + sponsorship: *811 required: - action - sponsorship @@ -227171,12 +227712,12 @@ x-webhooks: type: string required: - from - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - sponsorship: *809 + sponsorship: *811 required: - action - changes @@ -227253,17 +227794,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &810 + effective_date: &812 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - sponsorship: *809 + sponsorship: *811 required: - action - sponsorship @@ -227337,7 +227878,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &811 + changes: &813 type: object properties: tier: @@ -227381,13 +227922,13 @@ x-webhooks: - from required: - tier - effective_date: *810 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + effective_date: *812 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - sponsorship: *809 + sponsorship: *811 required: - action - changes @@ -227464,13 +228005,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *811 - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + changes: *813 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - sponsorship: *809 + sponsorship: *811 required: - action - changes @@ -227544,10 +228085,10 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -227630,10 +228171,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -228053,15 +228594,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *743 + enterprise: *745 id: description: The unique identifier of the status. type: integer - installation: *744 + installation: *746 name: type: string - organization: *745 - repository: *746 + organization: *747 + repository: *748 sender: *4 sha: description: The Commit SHA. @@ -228170,15 +228711,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - parent_issue_repo: *80 + parent_issue: *88 + parent_issue_repo: *82 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - installation: *744 - organization: *745 - repository: *746 + sub_issue: *88 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -228262,15 +228803,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - parent_issue_repo: *80 + parent_issue: *88 + parent_issue_repo: *82 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - installation: *744 - organization: *745 - repository: *746 + sub_issue: *88 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -228354,15 +228895,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - sub_issue_repo: *80 + sub_issue: *88 + sub_issue_repo: *82 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - installation: *744 - organization: *745 - repository: *746 + parent_issue: *88 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -228446,15 +228987,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *86 - sub_issue_repo: *80 + sub_issue: *88 + sub_issue_repo: *82 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *86 - installation: *744 - organization: *745 - repository: *746 + parent_issue: *88 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -228531,12 +229072,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - team: &812 + team: &814 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -228759,9 +229300,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 repository: title: Repository description: A git repository @@ -229219,7 +229760,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *812 + team: *814 required: - action - team @@ -229295,9 +229836,9 @@ x-webhooks: type: string enum: - created - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 repository: title: Repository description: A git repository @@ -229755,7 +230296,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *812 + team: *814 required: - action - team @@ -229832,9 +230373,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 repository: title: Repository description: A git repository @@ -230292,7 +230833,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *812 + team: *814 required: - action - team @@ -230436,9 +230977,9 @@ x-webhooks: - from required: - permissions - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 repository: title: Repository description: A git repository @@ -230896,7 +231437,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *812 + team: *814 required: - action - changes @@ -230974,9 +231515,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *743 - installation: *744 - organization: *745 + enterprise: *745 + installation: *746 + organization: *747 repository: title: Repository description: A git repository @@ -231434,7 +231975,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *812 + team: *814 required: - action - team @@ -231510,10 +232051,10 @@ x-webhooks: type: string enum: - started - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 required: - action @@ -231586,16 +232127,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *743 + enterprise: *745 inputs: type: object nullable: true additionalProperties: true - installation: *744 - organization: *745 + installation: *746 + organization: *747 ref: type: string - repository: *746 + repository: *748 sender: *4 workflow: type: string @@ -231677,10 +232218,10 @@ x-webhooks: type: string enum: - completed - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 workflow_job: allOf: @@ -231917,7 +232458,7 @@ x-webhooks: type: string required: - conclusion - deployment: *508 + deployment: *510 required: - action - repository @@ -231996,10 +232537,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 workflow_job: allOf: @@ -232259,7 +232800,7 @@ x-webhooks: required: - status - steps - deployment: *508 + deployment: *510 required: - action - repository @@ -232338,10 +232879,10 @@ x-webhooks: type: string enum: - queued - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 workflow_job: type: object @@ -232476,7 +233017,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *508 + deployment: *510 required: - action - repository @@ -232555,10 +233096,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 workflow_job: type: object @@ -232694,7 +233235,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *508 + deployment: *510 required: - action - repository @@ -232774,12 +233315,12 @@ x-webhooks: type: string enum: - completed - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object @@ -233778,12 +234319,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object @@ -234767,12 +235308,12 @@ x-webhooks: type: string enum: - requested - enterprise: *743 - installation: *744 - organization: *745 - repository: *746 + enterprise: *745 + installation: *746 + organization: *747 + repository: *748 sender: *4 - workflow: *760 + workflow: *762 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 2be9dc832c..f826dc7b52 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -462,21 +466,21 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#github-api-root" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#github-api-root" } } }, "/advisories": { "get": { "summary": "List global security advisories", - "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", + "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", "tags": [ "security-advisories" ], "operationId": "security-advisories/list-global-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#list-global-security-advisories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#list-global-security-advisories" }, "parameters": [ { @@ -596,7 +600,7 @@ { "name": "published", "in": "query", - "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, 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).\"", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, 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).\"", "schema": { "type": "string" } @@ -604,14 +608,14 @@ { "name": "updated", "in": "query", - "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, 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).\"", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, 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).\"", "schema": { "type": "string" } }, { "name": "modified", - "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, 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).\"", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, 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).\"", "in": "query", "schema": { "type": "string" @@ -635,7 +639,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -644,7 +648,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -667,7 +671,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -1383,7 +1387,7 @@ "operationId": "security-advisories/get-global-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#get-a-global-security-advisory" }, "parameters": [ { @@ -2039,14 +2043,14 @@ "/app": { "get": { "summary": "Get the authenticated app", - "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-the-authenticated-app" }, "parameters": [], "responses": { @@ -2424,14 +2428,14 @@ "/app-manifests/{code}/conversions": { "post": { "summary": "Create a GitHub App from a manifest", - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "tags": [ "apps" ], "operationId": "apps/create-from-manifest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-github-app-from-a-manifest" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-a-github-app-from-a-manifest" }, "parameters": [ { @@ -2906,14 +2910,14 @@ "/app/hook/config": { "get": { "summary": "Get a webhook configuration for an app", - "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" }, "responses": { "200": { @@ -2938,7 +2942,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -2978,14 +2982,14 @@ }, "patch": { "summary": "Update a webhook configuration for an app", - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/update-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#update-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" }, "requestBody": { "required": true, @@ -3007,7 +3011,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -3060,7 +3064,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -3102,19 +3106,19 @@ "/app/hook/deliveries": { "get": { "summary": "List deliveries for an app webhook", - "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#list-deliveries-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#list-deliveries-for-an-app-webhook" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -3419,14 +3423,14 @@ "/app/hook/deliveries/{delivery_id}": { "get": { "summary": "Get a delivery for an app webhook", - "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -3770,14 +3774,14 @@ "/app/hook/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an app webhook", - "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -3953,12 +3957,12 @@ "operationId": "apps/list-installation-requests-for-authenticated-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installation-requests-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installation-requests-for-the-authenticated-app" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -3967,7 +3971,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -4424,19 +4428,19 @@ "/app/installations": { "get": { "summary": "List installations for the authenticated app", - "description": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installations-for-the-authenticated-app" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -4445,7 +4449,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -5457,14 +5461,14 @@ "/app/installations/{installation_id}": { "get": { "summary": "Get an installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -6479,14 +6483,14 @@ }, "delete": { "summary": "Delete an installation for the authenticated app", - "description": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/delete-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#delete-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#delete-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -6546,14 +6550,14 @@ "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nEnterprise account installations do not have access to repositories and cannot be scoped down using the `permissions` parameter.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nEnterprise account installations do not have access to repositories and cannot be scoped down using the `permissions` parameter.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/create-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-an-installation-access-token-for-an-app" }, "parameters": [ { @@ -8628,14 +8632,14 @@ "/app/installations/{installation_id}/suspended": { "put": { "summary": "Suspend an app installation", - "description": "Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/suspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#suspend-an-app-installation" }, "parameters": [ { @@ -8693,14 +8697,14 @@ }, "delete": { "summary": "Unsuspend an app installation", - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/unsuspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#unsuspend-an-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#unsuspend-an-app-installation" }, "parameters": [ { @@ -8767,7 +8771,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-authorization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#delete-an-app-authorization" }, "parameters": [ { @@ -8903,7 +8907,7 @@ "operationId": "apps/check-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#check-a-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#check-a-token" }, "parameters": [ { @@ -9963,7 +9967,7 @@ "operationId": "apps/reset-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#reset-a-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#reset-a-token" }, "parameters": [ { @@ -10997,7 +11001,7 @@ "operationId": "apps/delete-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#delete-an-app-token" }, "parameters": [ { @@ -11133,7 +11137,7 @@ "operationId": "apps/scope-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-scoped-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-a-scoped-access-token" }, "parameters": [ { @@ -12771,7 +12775,7 @@ "operationId": "apps/get-by-slug", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app" }, "parameters": [ { @@ -13217,7 +13221,7 @@ "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-an-assignment" }, "parameters": [ { @@ -13560,7 +13564,7 @@ "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -13574,7 +13578,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -13583,7 +13587,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -13943,7 +13947,7 @@ "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-assignment-grades" }, "parameters": [ { @@ -14106,12 +14110,12 @@ "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-classrooms" }, "parameters": [ { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -14120,7 +14124,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -14200,7 +14204,7 @@ "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-a-classroom" }, "parameters": [ { @@ -14358,7 +14362,7 @@ "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-assignments-for-a-classroom" }, "parameters": [ { @@ -14372,7 +14376,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -14381,7 +14385,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -14598,7 +14602,7 @@ "operationId": "codes-of-conduct/get-all-codes-of-conduct", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" }, "parameters": [], "responses": { @@ -14687,7 +14691,7 @@ "operationId": "codes-of-conduct/get-conduct-code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" }, "parameters": [ { @@ -14801,7 +14805,7 @@ "operationId": "credentials/revoke", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/credentials/revoke#revoke-a-list-of-credentials" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/credentials/revoke#revoke-a-list-of-credentials" }, "requestBody": { "required": true, @@ -14931,7 +14935,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/emojis/emojis#get-emojis" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/emojis/emojis#get-emojis" }, "parameters": [], "responses": { @@ -16853,7 +16857,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics" }, "parameters": [ { @@ -16867,7 +16871,7 @@ }, { "name": "date_start", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -16876,7 +16880,7 @@ }, { "name": "date_end", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -17302,7 +17306,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise" }, "parameters": [ { @@ -17454,7 +17458,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise" }, "parameters": [ { @@ -17606,7 +17610,7 @@ "operationId": "actions/get-actions-cache-retention-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" }, "parameters": [ { @@ -17715,7 +17719,7 @@ "operationId": "actions/set-actions-cache-retention-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise" }, "parameters": [ { @@ -17889,7 +17893,7 @@ "operationId": "actions/get-actions-cache-storage-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise" }, "parameters": [ { @@ -17998,7 +18002,7 @@ "operationId": "actions/set-actions-cache-storage-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise" }, "parameters": [ { @@ -18172,7 +18176,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" }, "parameters": [ { @@ -18245,7 +18249,7 @@ "operationId": "actions/list-hosted-runners-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise" }, "parameters": [ { @@ -18259,7 +18263,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -18268,7 +18272,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -18553,7 +18557,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -18879,7 +18883,7 @@ "operationId": "actions/list-custom-images-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-custom-images-for-an-enterprise" }, "parameters": [ { @@ -19012,7 +19016,7 @@ "operationId": "actions/get-custom-image-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners" }, "parameters": [ { @@ -19130,7 +19134,7 @@ "operationId": "actions/delete-custom-image-from-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise" }, "parameters": [ { @@ -19175,7 +19179,7 @@ "operationId": "actions/list-custom-image-versions-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise" }, "parameters": [ { @@ -19299,7 +19303,7 @@ "operationId": "actions/get-custom-image-version-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners" }, "parameters": [ { @@ -19405,7 +19409,7 @@ "operationId": "actions/delete-custom-image-version-from-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise" }, "parameters": [ { @@ -19460,7 +19464,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise" }, "parameters": [ { @@ -19569,7 +19573,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise" }, "parameters": [ { @@ -19678,7 +19682,7 @@ "operationId": "actions/get-hosted-runners-limits-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise" }, "parameters": [ { @@ -19757,7 +19761,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise" }, "parameters": [ { @@ -19855,7 +19859,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise" }, "parameters": [ { @@ -19924,7 +19928,7 @@ "operationId": "actions/get-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -20182,7 +20186,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -20496,7 +20500,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -20748,7 +20752,7 @@ "operationId": "actions/set-actions-oidc-custom-issuer-policy-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise" }, "parameters": [ { @@ -20808,7 +20812,7 @@ "operationId": "oidc/list-oidc-custom-property-inclusions-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise" }, "parameters": [ { @@ -20939,7 +20943,7 @@ "operationId": "oidc/create-oidc-custom-property-inclusion-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise" }, "parameters": [ { @@ -21070,7 +21074,7 @@ "operationId": "oidc/delete-oidc-custom-property-inclusion-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise" }, "parameters": [ { @@ -21147,7 +21151,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -21233,7 +21237,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -21315,7 +21319,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise" }, "parameters": [ { @@ -21408,7 +21412,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise" }, "parameters": [ { @@ -21566,7 +21570,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise" }, "parameters": [ { @@ -21654,7 +21658,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise" }, "parameters": [ { @@ -21817,7 +21821,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise" }, "parameters": [ { @@ -21918,7 +21922,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise" }, "parameters": [ { @@ -22090,7 +22094,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -22104,7 +22108,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -22113,7 +22117,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -22257,7 +22261,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -22326,7 +22330,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -22369,7 +22373,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -22414,7 +22418,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -22484,7 +22488,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -22559,7 +22563,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise" }, "parameters": [ { @@ -22642,7 +22646,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise" }, "parameters": [ { @@ -22793,14 +22797,14 @@ "/enterprises/{enterprise}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an enterprise", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -22861,14 +22865,14 @@ }, "put": { "summary": "Set default workflow permissions for an enterprise", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -22937,7 +22941,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" }, "parameters": [ { @@ -22951,7 +22955,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -22960,7 +22964,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -23124,7 +23128,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -23326,7 +23330,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -23453,7 +23457,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -23637,7 +23641,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" }, "parameters": [ { @@ -23682,7 +23686,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -23705,7 +23709,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -23714,7 +23718,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -23858,7 +23862,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -23936,7 +23940,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -23988,7 +23992,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -24042,7 +24046,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -24065,7 +24069,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -24074,7 +24078,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -24269,7 +24273,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -24347,7 +24351,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" }, "parameters": [ { @@ -24399,7 +24403,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" }, "parameters": [ { @@ -24453,7 +24457,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" }, "parameters": [ { @@ -24475,7 +24479,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -24484,7 +24488,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -24677,7 +24681,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" }, "parameters": [ { @@ -24788,7 +24792,7 @@ "operationId": "actions/generate-runner-jitconfig-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" }, "parameters": [ { @@ -25088,7 +25092,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" }, "parameters": [ { @@ -25926,7 +25930,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" }, "parameters": [ { @@ -26764,7 +26768,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -26920,7 +26924,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" }, "parameters": [ { @@ -26995,7 +26999,7 @@ "operationId": "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -27138,7 +27142,7 @@ "operationId": "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -27345,7 +27349,7 @@ "operationId": "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -27552,7 +27556,7 @@ "operationId": "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -27722,7 +27726,7 @@ "operationId": "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -27906,7 +27910,7 @@ "operationId": "announcement-banners/get-announcement-banner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise" }, "parameters": [ { @@ -27931,7 +27935,7 @@ "properties": { "announcement": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -27986,7 +27990,7 @@ "operationId": "announcement-banners/set-announcement-banner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise" }, "requestBody": { "required": true, @@ -27999,7 +28003,7 @@ "properties": { "announcement": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -28058,7 +28062,7 @@ "properties": { "announcement": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -28113,7 +28117,7 @@ "operationId": "announcement-banners/remove-announcement-banner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise" }, "parameters": [ { @@ -28149,7 +28153,7 @@ "operationId": "enterprise-apps/installable-organizations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed" }, "parameters": [ { @@ -28163,7 +28167,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -28172,7 +28176,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -28248,7 +28252,7 @@ "operationId": "enterprise-apps/installable-organization-accessible-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization" }, "parameters": [ { @@ -28271,7 +28275,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -28280,7 +28284,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -28361,7 +28365,7 @@ "operationId": "enterprise-apps/organization-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization" }, "parameters": [ { @@ -28384,7 +28388,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -28393,7 +28397,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -28970,7 +28974,7 @@ "operationId": "enterprise-apps/create-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization" }, "parameters": [ { @@ -30988,7 +30992,7 @@ "operationId": "enterprise-apps/delete-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" }, "parameters": [ { @@ -31099,7 +31103,7 @@ "operationId": "enterprise-apps/organization-installation-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" }, "parameters": [ { @@ -31136,7 +31140,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -31145,7 +31149,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -31224,7 +31228,7 @@ "operationId": "enterprise-apps/change-installation-repository-access-selection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" }, "parameters": [ { @@ -32283,7 +32287,7 @@ "operationId": "enterprise-apps/grant-repository-access-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation" }, "parameters": [ { @@ -32425,7 +32429,7 @@ "operationId": "enterprise-apps/remove-repository-access-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation" }, "parameters": [ { @@ -32602,13 +32606,13 @@ "get": { "summary": "Get the audit log for an enterprise", "operationId": "enterprise-admin/get-audit-log", - "description": "Gets the audit log for an enterprise.\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an enterprise admin to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an enterprise.\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an enterprise admin to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" }, "parameters": [ { @@ -32622,7 +32626,7 @@ }, { "name": "phrase", - "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).", + "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).", "in": "query", "required": false, "schema": { @@ -32645,7 +32649,7 @@ }, { "name": "after", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -32654,7 +32658,7 @@ }, { "name": "before", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -32676,7 +32680,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -32685,7 +32689,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -32922,7 +32926,7 @@ "operationId": "enterprise-admin/get-audit-log-stream-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets" }, "parameters": [ { @@ -32987,7 +32991,7 @@ "operationId": "enterprise-admin/get-audit-log-streams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise" }, "parameters": [ { @@ -33083,7 +33087,7 @@ "operationId": "enterprise-admin/create-audit-log-stream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise" }, "parameters": [ { @@ -33482,7 +33486,7 @@ "operationId": "enterprise-admin/get-one-audit-log-stream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id" }, "parameters": [ { @@ -33582,7 +33586,7 @@ "operationId": "enterprise-admin/update-audit-log-stream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration" }, "parameters": [ { @@ -34006,7 +34010,7 @@ "operationId": "enterprise-admin/delete-audit-log-stream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise" }, "parameters": [ { @@ -34051,7 +34055,7 @@ "operationId": "enterprise-admin/list-push-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise" }, "x-github": { "githubCloudOnly": true, @@ -34133,7 +34137,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -34142,7 +34146,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -34505,7 +34509,7 @@ "operationId": "secret-scanning/list-enterprise-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise" }, "x-github": { "githubCloudOnly": true, @@ -34587,7 +34591,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -34596,7 +34600,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -34951,14 +34955,14 @@ "/enterprises/{enterprise}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an enterprise", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -34993,7 +34997,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -35002,7 +35006,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -35011,7 +35015,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -35020,7 +35024,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -36477,7 +36481,7 @@ "operationId": "code-security/get-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" }, "parameters": [ { @@ -36492,7 +36496,7 @@ { "name": "per_page", "in": "query", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "required": false, "schema": { "type": "integer", @@ -36501,7 +36505,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -36510,7 +36514,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -36958,7 +36962,7 @@ "operationId": "code-security/create-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" }, "parameters": [ { @@ -37700,7 +37704,7 @@ "operationId": "code-security/get-default-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" }, "parameters": [ { @@ -38130,7 +38134,7 @@ "operationId": "code-security/get-single-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" }, "parameters": [ { @@ -38561,7 +38565,7 @@ "operationId": "code-security/update-enterprise-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" }, "parameters": [ { @@ -39259,7 +39263,7 @@ "operationId": "code-security/delete-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" }, "parameters": [ { @@ -39442,7 +39446,7 @@ "operationId": "code-security/attach-enterprise-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" }, "parameters": [ { @@ -39609,7 +39613,7 @@ "operationId": "code-security/set-configuration-as-default-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" }, "parameters": [ { @@ -40105,7 +40109,7 @@ "operationId": "code-security/get-repositories-for-enterprise-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" }, "parameters": [ { @@ -40128,7 +40132,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -40138,7 +40142,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -40147,7 +40151,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -40760,14 +40764,14 @@ "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "operationId": "secret-scanning/get-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -40893,14 +40897,14 @@ }, "patch": { "summary": "Update code security and analysis features for an enterprise", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "operationId": "secret-scanning/patch-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -40922,28 +40926,28 @@ "properties": { "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"" + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security).\"" }, "advanced_security_enabled_new_user_namespace_repos": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"" + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security).\"" }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" + "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"" + "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\"" }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" + "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" }, "secret_scanning_push_protection_custom_link": { "type": "string", "nullable": true, - "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." + "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." }, "secret_scanning_non_provider_patterns_enabled_for_new_repositories": { "type": "boolean", @@ -41023,7 +41027,7 @@ "operationId": "enterprise-admin/get-consumed-licenses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#list-enterprise-consumed-licenses" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#list-enterprise-consumed-licenses" }, "parameters": [ { @@ -41037,7 +41041,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -41046,7 +41050,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -41253,14 +41257,14 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data).\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/list-copilot-seats-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise" }, "parameters": [ { @@ -41274,7 +41278,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -41283,7 +41287,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -42063,7 +42067,7 @@ "operationId": "copilot/add-copilot-seats-for-enterprise-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise" }, "parameters": [ { @@ -42261,7 +42265,7 @@ "operationId": "copilot/cancel-copilot-seats-for-enterprise-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise" }, "parameters": [ { @@ -42483,7 +42487,7 @@ "operationId": "copilot/add-copilot-seats-for-enterprise-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise" }, "parameters": [ { @@ -42681,7 +42685,7 @@ "operationId": "copilot/cancel-copilot-seats-for-enterprise-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise" }, "parameters": [ { @@ -42874,14 +42878,14 @@ "/enterprises/{enterprise}/copilot/content_exclusion": { "get": { "summary": "Get Copilot content exclusion rules for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise).\"\n\nEnterprise owners can view details about Copilot content exclusion rules for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `read:enterprise` or `copilot` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise).\"\n\nEnterprise owners can view details about Copilot content exclusion rules for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `read:enterprise` or `copilot` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", "tags": [ "copilot" ], "operationId": "copilot/copilot-content-exclusion-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-enterprise" }, "parameters": [ { @@ -43040,14 +43044,14 @@ }, "put": { "summary": "Set Copilot content exclusion rules for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise).\"\n\nEnterprise owners can set Copilot content exclusion rules for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `admin:enterprise` or `copilot` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise).\"\n\nEnterprise owners can set Copilot content exclusion rules for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `admin:enterprise` or `copilot` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-content-exclusion-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-enterprise" }, "parameters": [ { @@ -43327,7 +43331,7 @@ "operationId": "copilot/get-copilot-custom-agents-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#get-custom-agents-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#get-custom-agents-for-an-enterprise" }, "parameters": [ { @@ -43341,7 +43345,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -43350,7 +43354,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -43538,7 +43542,7 @@ "operationId": "copilot/get-copilot-custom-agents-source-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#get-the-source-organization-for-custom-agents-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#get-the-source-organization-for-custom-agents-in-an-enterprise" }, "parameters": [ { @@ -43693,7 +43697,7 @@ "operationId": "copilot/set-copilot-custom-agents-source-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#set-the-source-organization-for-custom-agents-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#set-the-source-organization-for-custom-agents-in-an-enterprise" }, "parameters": [ { @@ -44004,7 +44008,7 @@ "operationId": "copilot/delete-copilot-custom-agents-source-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#delete-the-custom-agents-source-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#delete-the-custom-agents-source-for-an-enterprise" }, "x-github": { "githubCloudOnly": true, @@ -44092,7 +44096,7 @@ "operationId": "copilot/copilot-metrics-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" }, "parameters": [ { @@ -44124,7 +44128,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -44133,7 +44137,7 @@ }, { "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -44732,7 +44736,7 @@ "operationId": "copilot/copilot-enterprise-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -44896,7 +44900,7 @@ "operationId": "copilot/copilot-enterprise-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics" }, "parameters": [ { @@ -45056,7 +45060,7 @@ "operationId": "copilot/copilot-users-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -45220,7 +45224,7 @@ "operationId": "copilot/copilot-users-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" }, "parameters": [ { @@ -45380,7 +45384,7 @@ "operationId": "copilot/set-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" }, "parameters": [ { @@ -45509,7 +45513,7 @@ "operationId": "copilot/add-organizations-to-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" }, "parameters": [ { @@ -45666,7 +45670,7 @@ "operationId": "copilot/remove-organizations-from-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy" }, "parameters": [ { @@ -45818,14 +45822,14 @@ "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", - "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", + "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" }, "parameters": [ { @@ -45956,7 +45960,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -45965,7 +45969,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -45974,7 +45978,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -47785,23 +47789,17 @@ } } }, - "/enterprises/{enterprise}/dismissal-requests/secret-scanning": { + "/enterprises/{enterprise}/dependabot/repository-access": { "get": { - "summary": "List alert dismissal requests for secret scanning for an enterprise", - "description": "Lists requests to dismiss secret scanning alerts in an enterprise.\n\nThe authenticated user must be an enterprise owner or an enterprise security manager to access this endpoint.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", + "summary": "Lists the repositories Dependabot can access in an enterprise", + "description": "Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", "tags": [ - "secret-scanning" + "dependabot" ], - "operationId": "secret-scanning/list-enterprise-dismissal-requests", + "operationId": "dependabot/repository-access-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-enterprise" - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "secret-scanning", - "subcategory": "alert-dismissal-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" }, "parameters": [ { @@ -47814,368 +47812,1273 @@ } }, { - "name": "organization_name", - "description": "The name of the organization to filter on.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "reviewer", - "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "requester", - "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "time_period", - "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" - } - }, - { - "name": "request_status", - "description": "The status of the dismissal request to filter on. When specified, only requests with this status will be returned.", + "name": "page", "in": "query", + "description": "The page number of results to fetch.", "required": false, "schema": { - "type": "string", - "enum": [ - "completed", - "cancelled", - "approved", - "expired", - "denied", - "open", - "all" - ], - "default": "all" + "type": "integer", + "minimum": 1, + "default": 1 } }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", + "description": "Number of results per page.", + "required": false, "schema": { "type": "integer", + "minimum": 1, + "maximum": 100, "default": 30 } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { "200": { - "description": "A list of the alert dismissal requests.", + "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Secret scanning alert dismissal request", - "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "number": { - "type": "integer", - "description": "The number uniquely identifying the dismissal request within its repository." - }, - "repository": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true + }, + "accessible_repositories": { + "type": "array", + "items": { + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", - "description": "The repository the dismissal request is for.", "properties": { "id": { "type": "integer", - "description": "The ID of the repository the dismissal request is for." + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", - "description": "The name of the repository the dismissal request is for." + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "description": "The full name of the repository the dismissal request is for." - } - } - }, - "organization": { - "type": "object", - "description": "The organization associated with the repository the dismissal request is for.", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the organization." + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, - "name": { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The name of the organization." - } - } - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who requested the dismissal." + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, - "actor_name": { + "description": { "type": "string", - "description": "The name of the GitHub user who requested the dismissal." - } - } - }, - "request_type": { - "type": "string", - "description": "The type of request." - }, - "data": { - "nullable": true, - "type": "array", - "description": "Data describing the secret alert that is being requested to be dismissed.", - "items": { - "type": "object", - "properties": { - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "alert_number": { - "type": "string", - "description": "The number of the secret scanning alert that was detected." - }, - "reason": { - "type": "string", - "description": "The reason the user provided for requesting the dismissal.", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - } + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." } - } - }, - "resource_identifier": { - "type": "string", - "description": "The number of the secret scanning alert that was detected.", - "example": 1234 - }, - "status": { - "type": "string", - "description": "The status of the dismissal request.", - "enum": [ - "pending", - "denied", - "approved", - "cancelled", - "expired" - ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the dismissal request.", + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the dismissal request will expire." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the dismissal request was created." - }, - "responses": { - "type": "array", - "description": "The responses to the dismissal request.", - "nullable": true, - "items": { - "title": "Bypass response", - "description": "A response made by a delegated bypasser to a bypass request.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the response to the bypass request." - }, - "reviewer": { - "type": "object", - "description": "The user who reviewed the bypass request.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who reviewed the bypass request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who reviewed the bypass request." - } - } - }, - "status": { - "type": "string", - "description": "The response status to the bypass request until dismissed.", - "enum": [ - "approved", - "denied", - "dismissed" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the response to the bypass request was created." - } - } - } - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/1" - }, - "html_url": { - "type": "string", - "description": "The URL to view the dismissal request in a browser.", - "format": "uri", - "example": "https://github.com/octo-org/smile/security/secret-scanning/17" } } - } + }, + "additionalProperties": false }, "examples": { "default": { - "value": [ - { - "id": 21, - "number": 42, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "secret_scanning_closure", - "data": [ - { - "secret_type": "adafruit_io_key", - "alert_number": 17, - "reason": "false_positive" - } - ], - "resource_identifier": 17, - "status": "denied", - "requester_comment": "Test token used in the readme as an example", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", - "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" - }, - { - "id": 22, - "number": 43, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "secret_scanning_closure", - "data": [ - { - "secret_type": "adafruit_io_key", - "alert_number": 19 - } - ], - "resource_identifier": 19, - "status": "denied", - "requester_comment": "Test token used in the readme as an example", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 46, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "approved", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", - "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" - } - ] + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an enterprise", + "description": "Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot in an enterprise", + "description": "Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nThe authenticated user must be an enterprise owner to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/enterprises/{enterprise}/dismissal-requests/secret-scanning": { + "get": { + "summary": "List alert dismissal requests for secret scanning for an enterprise", + "description": "Lists requests to dismiss secret scanning alerts in an enterprise.\n\nThe authenticated user must be an enterprise owner or an enterprise security manager to access this endpoint.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-enterprise-dismissal-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-enterprise" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "secret-scanning", + "subcategory": "alert-dismissal-requests" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "organization_name", + "description": "The name of the organization to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "The status of the dismissal request to filter on. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "A list of the alert dismissal requests.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "nullable": true, + "type": "array", + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected.", + "example": 1234 + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the dismissal request.", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the dismissal request.", + "nullable": true, + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/1" + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri", + "example": "https://github.com/octo-org/smile/security/secret-scanning/17" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17, + "reason": "false_positive" + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + { + "id": 22, + "number": 43, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 19 + } + ], + "resource_identifier": 19, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 46, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" + } + ] + } + } + } + } + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -48265,7 +49168,7 @@ "operationId": "enterprise-admin/list-enterprise-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise" }, "parameters": [ { @@ -48551,7 +49454,7 @@ "operationId": "enterprise-admin/revoke-all-enterprise-roles-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team" }, "parameters": [ { @@ -48651,7 +49554,7 @@ "operationId": "enterprise-admin/assign-team-to-enterprise-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team" }, "parameters": [ { @@ -48758,7 +49661,7 @@ "operationId": "enterprise-admin/revoke-enterprise-role-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team" }, "parameters": [ { @@ -48867,7 +49770,7 @@ "operationId": "enterprise-admin/remove-all-enterprise-roles-from-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user" }, "parameters": [ { @@ -48967,7 +49870,7 @@ "operationId": "enterprise-admin/assign-enterprise-role-to-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user" }, "parameters": [ { @@ -49074,7 +49977,7 @@ "operationId": "enterprise-admin/remove-enterprise-user-role-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment" }, "parameters": [ { @@ -49183,7 +50086,7 @@ "operationId": "enterprise-admin/get-enterprise-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-an-enterprise-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#get-an-enterprise-role" }, "parameters": [ { @@ -49436,7 +50339,7 @@ "operationId": "enterprise-admin/list-enterprise-role-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role" }, "parameters": [ { @@ -49459,7 +50362,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -49468,7 +50371,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -49647,7 +50550,7 @@ "operationId": "enterprise-admin/list-enterprise-role-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role" }, "parameters": [ { @@ -49670,7 +50573,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -49679,7 +50582,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -50061,14 +50964,14 @@ "/enterprises/{enterprise}/installation": { "get": { "summary": "Get an enterprise installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-enterprise-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" }, "parameters": [ { @@ -51062,7 +51965,7 @@ "operationId": "enterprise-admin/get-license-sync-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-a-license-sync-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-a-license-sync-status" }, "parameters": [ { @@ -51163,7 +52066,7 @@ "operationId": "copilot/get-copilot-seat-details-for-enterprise-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user" }, "parameters": [ { @@ -51953,7 +52856,7 @@ "operationId": "hosted-compute/list-network-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise" }, "parameters": [ { @@ -51967,7 +52870,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -51976,7 +52879,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -52121,7 +53024,7 @@ "operationId": "hosted-compute/create-network-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise" }, "parameters": [ { @@ -52296,7 +53199,7 @@ "operationId": "hosted-compute/get-network-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise" }, "parameters": [ { @@ -52425,7 +53328,7 @@ "operationId": "hosted-compute/update-network-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise" }, "parameters": [ { @@ -52603,7 +53506,7 @@ "operationId": "hosted-compute/delete-network-configuration-from-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise" }, "parameters": [ { @@ -52649,7 +53552,7 @@ "operationId": "hosted-compute/get-network-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise" }, "parameters": [ { @@ -52755,7 +53658,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise" }, "parameters": [ { @@ -52973,7 +53876,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise" }, "parameters": [ { @@ -53368,7 +54271,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise" }, "parameters": [ { @@ -53577,7 +54480,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise" }, "parameters": [ { @@ -53901,7 +54804,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise" }, "parameters": [ { @@ -54028,7 +54931,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise" }, "parameters": [ { @@ -54042,7 +54945,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -54051,7 +54954,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -54225,7 +55128,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise" }, "parameters": [ { @@ -54465,7 +55368,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-get-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" }, "parameters": [ { @@ -54679,7 +55582,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" }, "parameters": [ { @@ -55032,7 +55935,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-promote-definition-to-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise" }, "parameters": [ { @@ -55246,7 +56149,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-get-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise" }, "parameters": [ { @@ -55449,7 +56352,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise" }, "parameters": [ { @@ -55741,7 +56644,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-delete-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" }, "parameters": [ { @@ -55838,7 +56741,7 @@ "operationId": "repos/create-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -57469,7 +58372,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -57479,7 +58382,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -58820,7 +59723,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -58830,7 +59733,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -59014,7 +59917,7 @@ "operationId": "repos/get-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -60277,7 +61180,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -60287,7 +61190,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -60469,7 +61372,7 @@ "operationId": "repos/update-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -62108,7 +63011,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -62118,7 +63021,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -63455,7 +64358,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -63465,7 +64368,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -63647,7 +64550,7 @@ "operationId": "repos/delete-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -63744,7 +64647,7 @@ "operationId": "enterprise-admin/get-enterprise-ruleset-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-history" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-enterprise-ruleset-history" }, "parameters": [ { @@ -63758,7 +64661,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -63767,7 +64670,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -63928,7 +64831,7 @@ "operationId": "enterprise-admin/get-enterprise-ruleset-version", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-version" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-enterprise-ruleset-version" }, "parameters": [ { @@ -64116,14 +65019,14 @@ "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users.", + "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users.", "tags": [ "secret-scanning" ], "operationId": "secret-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -64151,7 +65054,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -64160,7 +65063,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -64246,7 +65149,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -64255,7 +65158,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -64264,7 +65167,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -64512,7 +65415,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -66124,7 +67027,7 @@ "operationId": "secret-scanning/list-enterprise-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-enterprise-pattern-configurations" }, "x-github": { "githubCloudOnly": true, @@ -66409,7 +67312,7 @@ "operationId": "secret-scanning/update-enterprise-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#update-enterprise-pattern-configurations" }, "x-github": { "githubCloudOnly": true, @@ -66757,7 +67660,7 @@ "operationId": "billing/get-github-advanced-security-billing-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise" }, "parameters": [ { @@ -66784,7 +67687,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -66793,7 +67696,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -66938,7 +67841,7 @@ "operationId": "billing/get-all-budgets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-all-budgets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#get-all-budgets" }, "parameters": [ { @@ -67222,7 +68125,7 @@ "operationId": "billing/create-budget", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#create-a-budget" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#create-a-budget" }, "parameters": [ { @@ -67712,7 +68615,7 @@ "operationId": "billing/get-budget", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-a-budget-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#get-a-budget-by-id" }, "parameters": [ { @@ -68026,7 +68929,7 @@ "operationId": "billing/update-budget", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#update-a-budget" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#update-a-budget" }, "parameters": [ { @@ -68563,7 +69466,7 @@ "operationId": "billing/delete-budget", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#delete-a-budget" }, "parameters": [ { @@ -68796,7 +69699,7 @@ "operationId": "billing/get-all-cost-centers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-all-cost-centers-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#get-all-cost-centers-for-an-enterprise" }, "parameters": [ { @@ -69074,7 +69977,7 @@ "operationId": "billing/create-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#create-a-new-cost-center" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#create-a-new-cost-center" }, "parameters": [ { @@ -69245,7 +70148,7 @@ "operationId": "billing/get-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-a-cost-center-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#get-a-cost-center-by-id" }, "parameters": [ { @@ -69268,7 +70171,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -69277,7 +70180,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -69518,7 +70421,7 @@ "operationId": "billing/update-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#update-a-cost-center-name" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#update-a-cost-center-name" }, "parameters": [ { @@ -69848,7 +70751,7 @@ "operationId": "billing/delete-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#delete-a-cost-center" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#delete-a-cost-center" }, "parameters": [ { @@ -70096,7 +70999,7 @@ "operationId": "billing/add-resource-to-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#add-resources-to-a-cost-center" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#add-resources-to-a-cost-center" }, "parameters": [ { @@ -70398,7 +71301,7 @@ "operationId": "billing/remove-resource-from-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#remove-resources-from-a-cost-center" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#remove-resources-from-a-cost-center" }, "parameters": [ { @@ -70638,7 +71541,7 @@ "operationId": "billing/get-github-billing-premium-request-usage-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise" }, "parameters": [ { @@ -71066,7 +71969,7 @@ "operationId": "billing/list-usage-report-exports", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#list-usage-report-exports" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#list-usage-report-exports" }, "parameters": [ { @@ -71350,7 +72253,7 @@ "operationId": "billing/create-usage-report-export", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#create-a-usage-report-export" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#create-a-usage-report-export" }, "parameters": [ { @@ -71713,7 +72616,7 @@ "operationId": "billing/get-usage-report-export", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#get-a-usage-report-export" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#get-a-usage-report-export" }, "parameters": [ { @@ -71968,14 +72871,14 @@ "/enterprises/{enterprise}/settings/billing/usage": { "get": { "summary": "Get billing usage report for an enterprise", - "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", + "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest/billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", "tags": [ "billing" ], "operationId": "billing/get-github-billing-usage-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-report-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-usage-report-for-an-enterprise" }, "parameters": [ { @@ -72274,7 +73177,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-summary-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-usage-summary-for-an-enterprise" }, "parameters": [ { @@ -72663,14 +73566,14 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/copilot-metrics-for-enterprise-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" }, "parameters": [ { @@ -72711,7 +73614,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -72720,7 +73623,7 @@ }, { "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -73319,7 +74222,7 @@ "operationId": "enterprise-teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" }, "parameters": [ { @@ -73333,7 +74236,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -73342,7 +74245,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -73501,7 +74404,7 @@ "operationId": "enterprise-teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#create-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team" }, "parameters": [ { @@ -73541,7 +74444,7 @@ }, "organization_selection_type": { "type": "string", - "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", "enum": [ "disabled", "selected", @@ -73552,7 +74455,7 @@ "group_id": { "nullable": true, "type": "string", - "description": "The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest//rest/scim#list-provisioned-scim-groups-for-an-enterprise)." + "description": "The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest/rest/scim#list-provisioned-scim-groups-for-an-enterprise)." } }, "required": [ @@ -73685,7 +74588,7 @@ "operationId": "enterprise-team-memberships/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team" }, "parameters": [ { @@ -73708,7 +74611,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -73717,7 +74620,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -73913,7 +74816,7 @@ "operationId": "enterprise-team-memberships/bulk-add", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members" }, "parameters": [ { @@ -74148,7 +75051,7 @@ "operationId": "enterprise-team-memberships/bulk-remove", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members" }, "parameters": [ { @@ -74383,7 +75286,7 @@ "operationId": "enterprise-team-memberships/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership" }, "parameters": [ { @@ -74587,7 +75490,7 @@ "operationId": "enterprise-team-memberships/add", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#add-team-member" }, "parameters": [ { @@ -74791,7 +75694,7 @@ "operationId": "enterprise-team-memberships/remove", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#remove-team-membership" }, "parameters": [ { @@ -74871,7 +75774,7 @@ "operationId": "enterprise-team-organizations/get-assignments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" }, "parameters": [ { @@ -74894,7 +75797,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -74903,7 +75806,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -75032,7 +75935,7 @@ "operationId": "enterprise-team-organizations/bulk-add", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" }, "parameters": [ { @@ -75209,7 +76112,7 @@ "operationId": "enterprise-team-organizations/bulk-remove", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" }, "parameters": [ { @@ -75286,7 +76189,7 @@ "operationId": "enterprise-team-organizations/get-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" }, "parameters": [ { @@ -75436,7 +76339,7 @@ "operationId": "enterprise-team-organizations/add", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" }, "parameters": [ { @@ -75583,7 +76486,7 @@ "operationId": "enterprise-team-organizations/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" }, "parameters": [ { @@ -75637,7 +76540,7 @@ "operationId": "enterprise-teams/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team" }, "parameters": [ { @@ -75805,7 +76708,7 @@ "operationId": "enterprise-teams/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team" }, "parameters": [ { @@ -75855,7 +76758,7 @@ }, "organization_selection_type": { "type": "string", - "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", "enum": [ "disabled", "selected", @@ -76028,7 +76931,7 @@ "operationId": "enterprise-teams/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team" }, "parameters": [ { @@ -76092,14 +76995,14 @@ "/enterprises/{enterprise}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "operationId": "secret-scanning/post-security-product-enablement-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" }, "parameters": [ { @@ -76197,12 +77100,12 @@ "operationId": "activity/list-public-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -76211,7 +77114,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -86558,14 +87461,14 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], "operationId": "activity/get-feeds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/feeds#get-feeds" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/feeds#get-feeds" }, "parameters": [], "responses": { @@ -86889,7 +87792,7 @@ "operationId": "gists/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gists-for-the-authenticated-user" }, "parameters": [ { @@ -86904,7 +87807,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -86913,7 +87816,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -87407,7 +88310,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#create-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#create-a-gist" }, "parameters": [], "requestBody": { @@ -88705,14 +89608,14 @@ "/gists/public": { "get": { "summary": "List public gists", - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "tags": [ "gists" ], "operationId": "gists/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-public-gists" }, "parameters": [ { @@ -88727,7 +89630,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -88736,7 +89639,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -89301,7 +90204,7 @@ "operationId": "gists/list-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-starred-gists" }, "parameters": [ { @@ -89316,7 +90219,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -89325,7 +90228,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -89840,14 +90743,14 @@ "/gists/{gist_id}": { "get": { "summary": "Get a gist", - "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#get-a-gist" }, "parameters": [ { @@ -91008,14 +91911,14 @@ }, "patch": { "summary": "Update a gist", - "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#update-a-gist" }, "parameters": [ { @@ -92448,7 +93351,7 @@ "operationId": "gists/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#delete-a-gist" }, "parameters": [ { @@ -92532,14 +93435,14 @@ "/gists/{gist_id}/comments": { "get": { "summary": "List gist comments", - "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#list-gist-comments" }, "parameters": [ { @@ -92553,7 +93456,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -92562,7 +93465,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -92876,14 +93779,14 @@ }, "post": { "summary": "Create a gist comment", - "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#create-a-gist-comment" }, "parameters": [ { @@ -93228,14 +94131,14 @@ "/gists/{gist_id}/comments/{comment_id}": { "get": { "summary": "Get a gist comment", - "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#get-a-gist-comment" }, "parameters": [ { @@ -93558,14 +94461,14 @@ }, "patch": { "summary": "Update a gist comment", - "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#update-a-gist-comment" }, "parameters": [ { @@ -93888,7 +94791,7 @@ "operationId": "gists/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#delete-a-gist-comment" }, "parameters": [ { @@ -93989,7 +94892,7 @@ "operationId": "gists/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gist-commits" }, "parameters": [ { @@ -94003,7 +94906,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -94012,7 +94915,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -94316,7 +95219,7 @@ "operationId": "gists/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gist-forks" }, "parameters": [ { @@ -94330,7 +95233,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -94339,7 +95242,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -95470,7 +96373,7 @@ "operationId": "gists/fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#fork-a-gist" }, "parameters": [ { @@ -96061,7 +96964,7 @@ "operationId": "gists/check-is-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#check-if-a-gist-is-starred" }, "parameters": [ { @@ -96129,14 +97032,14 @@ }, "put": { "summary": "Star a gist", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "gists" ], "operationId": "gists/star", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#star-a-gist" }, "parameters": [ { @@ -96225,7 +97128,7 @@ "operationId": "gists/unstar", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#unstar-a-gist" }, "parameters": [ { @@ -96309,14 +97212,14 @@ "/gists/{gist_id}/{sha}": { "get": { "summary": "Get a gist revision", - "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/get-revision", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#get-a-gist-revision" }, "parameters": [ { @@ -97546,14 +98449,14 @@ "/gitignore/templates": { "get": { "summary": "Get all gitignore templates", - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user).", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user).", "operationId": "gitignore/get-all-templates", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-all-gitignore-templates" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gitignore/gitignore#get-all-gitignore-templates" }, "parameters": [], "responses": { @@ -97598,14 +98501,14 @@ "/gitignore/templates/{name}": { "get": { "summary": "Get a gitignore template", - "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", + "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", "operationId": "gitignore/get-template", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-a-gitignore-template" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gitignore/gitignore#get-a-gitignore-template" }, "parameters": [ { @@ -97674,12 +98577,12 @@ "operationId": "apps/list-repos-accessible-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-repositories-accessible-to-the-app-installation" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -97688,7 +98591,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -98673,14 +99576,14 @@ "/installation/token": { "delete": { "summary": "Revoke an installation access token", - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", "tags": [ "apps" ], "operationId": "apps/revoke-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#revoke-an-installation-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#revoke-an-installation-access-token" }, "parameters": [], "responses": { @@ -98699,14 +99602,14 @@ "/issues": { "get": { "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -98824,7 +99727,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -98833,7 +99736,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -102192,14 +103095,14 @@ "/licenses": { "get": { "summary": "Get all commonly used licenses", - "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get-all-commonly-used", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-all-commonly-used-licenses" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-all-commonly-used-licenses" }, "parameters": [ { @@ -102212,7 +103115,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -102221,7 +103124,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -102351,14 +103254,14 @@ "/licenses/{license}": { "get": { "summary": "Get a license", - "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-a-license" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-a-license" }, "parameters": [ { @@ -102578,7 +103481,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/markdown/markdown#render-a-markdown-document" }, "parameters": [], "requestBody": { @@ -102681,7 +103584,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document-in-raw-mode" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" }, "parameters": [], "requestBody": { @@ -102754,14 +103657,14 @@ "/marketplace_listing/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account", - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-subscription-plan-for-account", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#get-a-subscription-plan-for-an-account" }, "parameters": [ { @@ -103162,19 +104065,19 @@ "/marketplace_listing/plans": { "get": { "summary": "List plans", - "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-plans", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-plans" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -103183,7 +104086,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -103385,14 +104288,14 @@ "/marketplace_listing/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan", - "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-accounts-for-plan", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-accounts-for-a-plan" }, "parameters": [ { @@ -103433,7 +104336,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -103442,7 +104345,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -103919,14 +104822,14 @@ "/marketplace_listing/stubbed/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account (stubbed)", - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-subscription-plan-for-account-stubbed", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed" }, "parameters": [ { @@ -104304,19 +105207,19 @@ "/marketplace_listing/stubbed/plans": { "get": { "summary": "List plans (stubbed)", - "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-plans-stubbed", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans-stubbed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-plans-stubbed" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -104325,7 +105228,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -104501,14 +105404,14 @@ "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan (stubbed)", - "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-accounts-for-plan-stubbed", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-accounts-for-a-plan-stubbed" }, "parameters": [ { @@ -104549,7 +105452,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -104558,7 +105461,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -104940,14 +105843,14 @@ "/meta": { "get": { "summary": "Get GitHub Enterprise Cloud meta information", - "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n> [!NOTE]\n> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", + "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n> [!NOTE]\n> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", "tags": [ "meta" ], "operationId": "meta/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-apiname-meta-information" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-apiname-meta-information" }, "parameters": [], "responses": { @@ -105298,7 +106201,7 @@ "operationId": "activity/list-public-events-for-repo-network", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-network-of-repositories" }, "parameters": [ { @@ -105321,7 +106224,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -105330,7 +106233,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -115715,7 +116618,7 @@ "operationId": "activity/list-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -115760,7 +116663,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -115769,7 +116672,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -116851,14 +117754,14 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-notifications-as-read" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-notifications-as-read" }, "parameters": [], "requestBody": { @@ -116990,12 +117893,12 @@ "operationId": "activity/get-thread", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#get-a-thread" }, "parameters": [ { "name": "thread_id", - "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/activity/notifications#list-notifications-for-the-authenticated-user)).", + "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/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -118002,12 +118905,12 @@ "operationId": "activity/mark-thread-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-a-thread-as-read" }, "parameters": [ { "name": "thread_id", - "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/activity/notifications#list-notifications-for-the-authenticated-user)).", + "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/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -118065,12 +118968,12 @@ "operationId": "activity/mark-thread-as-done", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-a-thread-as-done" }, "parameters": [ { "name": "thread_id", - "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/activity/notifications#list-notifications-for-the-authenticated-user)).", + "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/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -118094,19 +118997,19 @@ "/notifications/threads/{thread_id}/subscription": { "get": { "summary": "Get a thread subscription for the authenticated user", - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", "tags": [ "activity" ], "operationId": "activity/get-thread-subscription-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" }, "parameters": [ { "name": "thread_id", - "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/activity/notifications#list-notifications-for-the-authenticated-user)).", + "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/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -118245,19 +119148,19 @@ }, "put": { "summary": "Set a thread subscription", - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription) endpoint.", + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#delete-a-thread-subscription) endpoint.", "tags": [ "activity" ], "operationId": "activity/set-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#set-a-thread-subscription" }, "parameters": [ { "name": "thread_id", - "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/activity/notifications#list-notifications-for-the-authenticated-user)).", + "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/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -118420,19 +119323,19 @@ }, "delete": { "summary": "Delete a thread subscription", - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", "tags": [ "activity" ], "operationId": "activity/delete-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#delete-a-thread-subscription" }, "parameters": [ { "name": "thread_id", - "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/activity/notifications#list-notifications-for-the-authenticated-user)).", + "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/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -118546,7 +119449,7 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-octocat" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-octocat" }, "x-github": { "githubCloudOnly": false, @@ -118559,14 +119462,14 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], "operationId": "orgs/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations" }, "parameters": [ { @@ -118580,7 +119483,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -118715,14 +119618,14 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "Closing down - List custom repository roles in an organization", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -118985,7 +119888,7 @@ "operationId": "actions/get-actions-cache-retention-limit-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization" }, "parameters": [ { @@ -119094,7 +119997,7 @@ "operationId": "actions/set-actions-cache-retention-limit-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization" }, "parameters": [ { @@ -119268,7 +120171,7 @@ "operationId": "actions/get-actions-cache-storage-limit-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization" }, "parameters": [ { @@ -119377,7 +120280,7 @@ "operationId": "actions/set-actions-cache-storage-limit-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization" }, "parameters": [ { @@ -119551,7 +120454,7 @@ "operationId": "orgs/custom-properties-for-orgs-get-organization-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" }, "parameters": [ { @@ -119692,7 +120595,7 @@ "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" }, "parameters": [ { @@ -119911,14 +120814,14 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -120204,37 +121107,37 @@ "advanced_security_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { @@ -120251,7 +121154,7 @@ "secret_scanning_validity_checks_enabled": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -120419,14 +121322,14 @@ }, "patch": { "summary": "Update an organization", - "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -120500,15 +121403,15 @@ }, "members_can_create_internal_repositories": { "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_private_repositories": { "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_public_repositories": { "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_allowed_repository_creation_type": { "type": "string", @@ -120550,32 +121453,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { @@ -120588,7 +121491,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "deploy_keys_enabled_for_repositories": { @@ -120889,37 +121792,37 @@ "advanced_security_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { @@ -120936,7 +121839,7 @@ "secret_scanning_validity_checks_enabled": { "type": "boolean", "example": false, - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -121200,14 +122103,14 @@ }, "delete": { "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-cloud@latest/site-policy/github-terms/github-terms-of-service", "operationId": "orgs/delete", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#delete-an-organization" }, "parameters": [ { @@ -121307,7 +122210,7 @@ "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -121380,7 +122283,7 @@ "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -121394,7 +122297,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -121403,7 +122306,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -121507,7 +122410,7 @@ "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -121521,7 +122424,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -121530,7 +122433,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -121815,7 +122718,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -122140,7 +123043,7 @@ "operationId": "actions/list-custom-images-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { @@ -122273,7 +123176,7 @@ "operationId": "actions/get-custom-image-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" }, "parameters": [ { @@ -122391,7 +123294,7 @@ "operationId": "actions/delete-custom-image-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" }, "parameters": [ { @@ -122436,7 +123339,7 @@ "operationId": "actions/list-custom-image-versions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" }, "parameters": [ { @@ -122560,7 +123463,7 @@ "operationId": "actions/get-custom-image-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" }, "parameters": [ { @@ -122666,7 +123569,7 @@ "operationId": "actions/delete-custom-image-version-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" }, "parameters": [ { @@ -122721,7 +123624,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -122830,7 +123733,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -122939,7 +123842,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -123018,7 +123921,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { @@ -123116,7 +124019,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -123185,7 +124088,7 @@ "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -123443,7 +124346,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -123757,7 +124660,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -124009,7 +124912,7 @@ "operationId": "oidc/list-oidc-custom-property-inclusions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization" }, "parameters": [ { @@ -124137,7 +125040,7 @@ "operationId": "oidc/create-oidc-custom-property-inclusion-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization" }, "parameters": [ { @@ -124267,7 +125170,7 @@ "operationId": "oidc/delete-oidc-custom-property-inclusion-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization" }, "parameters": [ { @@ -124343,7 +125246,7 @@ "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -124372,6 +125275,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -124407,7 +125314,7 @@ "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -124435,6 +125342,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -124542,7 +125453,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -124628,7 +125539,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -124710,7 +125621,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -124825,7 +125736,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -125033,7 +125944,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -125120,7 +126031,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -125282,7 +126193,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -125408,7 +126319,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -125605,7 +126516,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -125619,7 +126530,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -125628,7 +126539,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -126552,7 +127463,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -126621,7 +127532,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -126664,7 +127575,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -126709,7 +127620,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -126779,7 +127690,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -126854,7 +127765,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -126973,7 +127884,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -127186,7 +128097,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -127200,7 +128111,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -127209,7 +128120,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -128180,7 +129091,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -128369,7 +129280,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -128558,7 +129469,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -128742,14 +129653,14 @@ "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -128810,14 +129721,14 @@ }, "put": { "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -128889,7 +129800,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" }, "parameters": [ { @@ -128903,7 +129814,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -128912,7 +129823,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -129087,7 +129998,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -129300,7 +130211,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -129436,7 +130347,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -129632,7 +130543,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" }, "parameters": [ { @@ -129677,7 +130588,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -129700,7 +130611,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -129709,7 +130620,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -129996,7 +130907,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -130019,7 +130930,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -130028,7 +130939,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -131093,7 +132004,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -131171,7 +132082,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -131223,7 +132134,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -131277,7 +132188,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -131300,7 +132211,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -131309,7 +132220,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -131504,7 +132415,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -131582,7 +132493,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -131634,7 +132545,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -131688,7 +132599,7 @@ "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ { @@ -131710,7 +132621,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -131719,7 +132630,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -131916,7 +132827,7 @@ "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -132027,7 +132938,7 @@ "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { @@ -132327,7 +133238,7 @@ "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -133165,7 +134076,7 @@ "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -134003,7 +134914,7 @@ "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -134159,7 +135070,7 @@ "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -134234,7 +135145,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -134377,7 +135288,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -134584,7 +135495,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -134791,7 +135702,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -134931,7 +135842,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -135115,7 +136026,7 @@ "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-organization-secrets" }, "parameters": [ { @@ -135129,7 +136040,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -135138,7 +136049,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -135264,7 +136175,7 @@ "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -135349,7 +136260,7 @@ "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -135440,14 +136351,14 @@ }, "put": { "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -135478,7 +136389,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -135496,7 +136407,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -135564,7 +136475,7 @@ "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -135609,7 +136520,7 @@ "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -135632,7 +136543,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -135641,7 +136552,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -136527,14 +137438,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -136565,7 +137476,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -136603,14 +137514,14 @@ "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -136657,14 +137568,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -136720,7 +137631,7 @@ "operationId": "actions/list-org-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables" }, "parameters": [ { @@ -136734,7 +137645,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -136743,7 +137654,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -136880,7 +137791,7 @@ "operationId": "actions/create-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-organization-variable" }, "parameters": [ { @@ -136986,7 +137897,7 @@ "operationId": "actions/get-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-organization-variable" }, "parameters": [ { @@ -137095,7 +138006,7 @@ "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -137187,7 +138098,7 @@ "operationId": "actions/delete-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-organization-variable" }, "parameters": [ { @@ -137232,7 +138143,7 @@ "operationId": "actions/list-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -137255,7 +138166,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -137264,7 +138175,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -138160,7 +139071,7 @@ "operationId": "actions/set-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#set-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -138239,7 +139150,7 @@ "operationId": "actions/add-selected-repo-to-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -138293,7 +139204,7 @@ "operationId": "actions/remove-selected-repo-from-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#remove-selected-repository-from-an-organization-variable" }, "parameters": [ { @@ -138349,7 +139260,7 @@ "operationId": "announcement-banners/get-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#get-announcement-banner-for-organization" }, "parameters": [ { @@ -138374,7 +139285,7 @@ "properties": { "announcement": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -138429,7 +139340,7 @@ "operationId": "announcement-banners/set-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#set-announcement-banner-for-organization" }, "requestBody": { "required": true, @@ -138442,7 +139353,7 @@ "properties": { "announcement": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -138501,7 +139412,7 @@ "properties": { "announcement": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -138556,7 +139467,7 @@ "operationId": "announcement-banners/remove-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#remove-announcement-banner-from-organization" }, "parameters": [ { @@ -138592,7 +139503,7 @@ "operationId": "orgs/create-artifact-deployment-record", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-an-artifact-deployment-record" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#create-an-artifact-deployment-record" }, "parameters": [ { @@ -138901,7 +139812,7 @@ "operationId": "orgs/set-cluster-deployment-records", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#set-cluster-deployment-records" }, "parameters": [ { @@ -139257,7 +140168,7 @@ "operationId": "orgs/create-artifact-storage-record", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record" }, "parameters": [ { @@ -139520,7 +140431,7 @@ "operationId": "orgs/list-artifact-deployment-records", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-deployment-records" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#list-artifact-deployment-records" }, "parameters": [ { @@ -139665,7 +140576,7 @@ "operationId": "orgs/list-artifact-storage-records", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#list-artifact-storage-records" }, "parameters": [ { @@ -139775,19 +140686,19 @@ "/orgs/{org}/attestations/bulk-list": { "post": { "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "orgs" ], "operationId": "orgs/list-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestations-by-bulk-subject-digests" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -139796,7 +140707,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -139805,7 +140716,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -140095,7 +141006,7 @@ "operationId": "orgs/delete-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-in-bulk" }, "parameters": [ { @@ -140222,7 +141133,7 @@ "operationId": "orgs/delete-attestations-by-subject-digest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-by-subject-digest" }, "parameters": [ { @@ -140297,12 +141208,12 @@ "operationId": "orgs/list-attestation-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestation-repositories" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -140311,7 +141222,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -140320,7 +141231,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -140401,7 +141312,7 @@ "operationId": "orgs/delete-attestations-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-by-id" }, "parameters": [ { @@ -140494,19 +141405,19 @@ "/orgs/{org}/attestations/{subject_digest}": { "get": { "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "orgs" ], "operationId": "orgs/list-attestations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestations" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -140515,7 +141426,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -140524,7 +141435,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -140752,14 +141663,14 @@ "/orgs/{org}/audit-log": { "get": { "summary": "Get the audit log for an organization", - "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "operationId": "orgs/get-audit-log", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-the-audit-log-for-an-organization" }, "parameters": [ { @@ -140773,7 +141684,7 @@ }, { "name": "phrase", - "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).", + "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).", "in": "query", "required": false, "schema": { @@ -140796,7 +141707,7 @@ }, { "name": "after", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -140805,7 +141716,7 @@ }, { "name": "before", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -140827,7 +141738,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -141064,7 +141975,7 @@ "operationId": "orgs/list-blocked-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#list-users-blocked-by-an-organization" }, "parameters": [ { @@ -141078,7 +141989,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -141087,7 +141998,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -141275,7 +142186,7 @@ "operationId": "orgs/check-blocked-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" }, "parameters": [ { @@ -141344,7 +142255,7 @@ "operationId": "orgs/block-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#block-a-user-from-an-organization" }, "parameters": [ { @@ -141456,7 +142367,7 @@ "operationId": "orgs/unblock-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#unblock-a-user-from-an-organization" }, "parameters": [ { @@ -141501,7 +142412,7 @@ "operationId": "orgs/list-push-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" }, "x-github": { "githubCloudOnly": true, @@ -141583,7 +142494,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -141592,7 +142503,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -141955,7 +142866,7 @@ "operationId": "secret-scanning/list-org-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org" }, "x-github": { "githubCloudOnly": true, @@ -142037,7 +142948,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -142046,7 +142957,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -142408,7 +143319,7 @@ "operationId": "campaigns/list-org-campaigns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#list-campaigns-for-an-organization" }, "parameters": [ { @@ -142422,7 +143333,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -142431,7 +143342,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -143072,7 +143983,7 @@ "operationId": "campaigns/create-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#create-a-campaign-for-an-organization" }, "parameters": [ { @@ -143816,7 +144727,7 @@ "operationId": "campaigns/get-campaign-summary", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { @@ -144413,7 +145324,7 @@ "operationId": "campaigns/update-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#update-a-campaign" }, "parameters": [ { @@ -145105,7 +146016,7 @@ "operationId": "campaigns/delete-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" }, "parameters": [ { @@ -145190,14 +146101,14 @@ "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -145232,7 +146143,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -145241,7 +146152,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -145250,7 +146161,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -145259,7 +146170,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -146734,7 +147645,7 @@ "operationId": "code-security/get-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-code-security-configurations-for-an-organization" }, "parameters": [ { @@ -146763,7 +147674,7 @@ { "name": "per_page", "in": "query", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "required": false, "schema": { "type": "integer", @@ -146772,7 +147683,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -146781,7 +147692,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -147227,7 +148138,7 @@ "operationId": "code-security/create-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#create-a-code-security-configuration" }, "parameters": [ { @@ -147931,7 +148842,7 @@ "operationId": "code-security/get-default-configurations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-default-code-security-configurations" }, "parameters": [ { @@ -148416,7 +149327,7 @@ "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { @@ -148436,6 +149347,9 @@ "schema": { "type": "object", "additionalProperties": false, + "required": [ + "selected_repository_ids" + ], "properties": { "selected_repository_ids": { "type": "array", @@ -148624,7 +149538,7 @@ "operationId": "code-security/get-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-a-code-security-configuration" }, "parameters": [ { @@ -149071,7 +149985,7 @@ "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { @@ -149753,7 +150667,7 @@ "operationId": "code-security/delete-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#delete-a-code-security-configuration" }, "parameters": [ { @@ -149936,7 +150850,7 @@ "operationId": "code-security/attach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#attach-a-configuration-to-repositories" }, "parameters": [ { @@ -150040,7 +150954,7 @@ "operationId": "code-security/set-configuration-as-default", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" }, "parameters": [ { @@ -150536,7 +151450,7 @@ "operationId": "code-security/get-repositories-for-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" }, "parameters": [ { @@ -150559,7 +151473,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -150569,7 +151483,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -150578,7 +151492,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -151198,12 +152112,12 @@ "operationId": "codespaces/list-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#list-codespaces-for-the-organization" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -151212,7 +152126,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -153130,7 +154044,7 @@ "operationId": "codespaces/set-codespaces-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces" }, "parameters": [ { @@ -153331,14 +154245,14 @@ "/orgs/{org}/codespaces/access/selected_users": { "post": { "summary": "Add users to Codespaces access for an organization", - "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/set-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" }, "parameters": [ { @@ -153526,14 +154440,14 @@ }, "delete": { "summary": "Remove users from Codespaces access for an organization", - "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/delete-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" }, "deprecated": true, "parameters": [ @@ -153730,7 +154644,7 @@ "operationId": "codespaces/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-organization-secrets" }, "parameters": [ { @@ -153744,7 +154658,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -153753,7 +154667,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -153875,7 +154789,7 @@ "operationId": "codespaces/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-public-key" }, "parameters": [ { @@ -153960,7 +154874,7 @@ "operationId": "codespaces/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-secret" }, "parameters": [ { @@ -154061,14 +154975,14 @@ }, "put": { "summary": "Create or update an organization secret", - "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -154099,7 +155013,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -154117,7 +155031,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -154278,7 +155192,7 @@ "operationId": "codespaces/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#delete-an-organization-secret" }, "parameters": [ { @@ -154349,7 +155263,7 @@ "operationId": "codespaces/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -154372,7 +155286,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -154381,7 +155295,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -155293,14 +156207,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -155331,7 +156245,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -155398,14 +156312,14 @@ "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -155547,14 +156461,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -155698,14 +156612,14 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -155963,14 +156877,14 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/list-copilot-seats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" }, "parameters": [ { @@ -155984,7 +156898,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -155993,7 +156907,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -156766,14 +157680,14 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/add-copilot-seats-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -156964,14 +157878,14 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -157164,14 +158078,14 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/add-copilot-seats-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -157362,14 +158276,14 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/cancel-copilot-seat-assignment-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -157569,7 +158483,7 @@ "operationId": "copilot/get-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" }, "parameters": [ { @@ -157753,7 +158667,7 @@ "operationId": "copilot/set-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" }, "parameters": [ { @@ -157993,7 +158907,7 @@ "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" }, "parameters": [ { @@ -158007,7 +158921,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -158016,7 +158930,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -159211,7 +160125,7 @@ "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" }, "parameters": [ { @@ -159479,7 +160393,7 @@ "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" }, "parameters": [ { @@ -159721,7 +160635,7 @@ "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" }, "parameters": [ { @@ -159889,14 +160803,14 @@ "/orgs/{org}/copilot/content_exclusion": { "get": { "summary": "Get Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", "tags": [ "copilot" ], "operationId": "copilot/copilot-content-exclusion-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" }, "parameters": [ { @@ -160052,14 +160966,14 @@ }, "put": { "summary": "Set Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-content-exclusion-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" }, "parameters": [ { @@ -160336,7 +161250,7 @@ "operationId": "copilot/copilot-metrics-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" }, "parameters": [ { @@ -160368,7 +161282,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -160377,7 +161291,7 @@ }, { "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -160969,14 +161883,14 @@ "/orgs/{org}/copilot/metrics/reports/organization-1-day": { "get": { "summary": "Get Copilot organization usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ "copilot" ], "operationId": "copilot/copilot-organization-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -161136,14 +162050,14 @@ "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { "get": { "summary": "Get Copilot organization usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ "copilot" ], "operationId": "copilot/copilot-organization-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" }, "parameters": [ { @@ -161296,14 +162210,14 @@ "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ "copilot" ], "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -161463,14 +162377,14 @@ "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { "get": { "summary": "Get Copilot organization users usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ "copilot" ], "operationId": "copilot/copilot-organization-users-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" }, "parameters": [ { @@ -161623,14 +162537,14 @@ "/orgs/{org}/credential-authorizations": { "get": { "summary": "List SAML SSO authorizations for an organization", - "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest/articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-saml-sso-authorizations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" }, "parameters": [ { @@ -161644,7 +162558,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -161817,7 +162731,7 @@ "operationId": "orgs/remove-saml-sso-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" }, "parameters": [ { @@ -161880,14 +162794,14 @@ "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-repo-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -162185,14 +163099,14 @@ }, "post": { "summary": "Create a custom repository role", - "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role" }, "parameters": [ { @@ -162582,14 +163496,14 @@ "/orgs/{org}/custom-repository-roles/{role_id}": { "get": { "summary": "Get a custom repository role", - "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/get-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#get-a-custom-repository-role" }, "parameters": [ { @@ -162862,14 +163776,14 @@ }, "patch": { "summary": "Update a custom repository role", - "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role" }, "parameters": [ { @@ -163262,14 +164176,14 @@ }, "delete": { "summary": "Delete a custom repository role", - "description": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#delete-a-custom-repository-role" }, "parameters": [ { @@ -163307,14 +164221,14 @@ "/orgs/{org}/custom_roles": { "post": { "summary": "Closing down - Create a custom role", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)\" endpoint instead.\n\nCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role)\" endpoint instead.\n\nCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---create-a-custom-role" }, "parameters": [ { @@ -163707,14 +164621,14 @@ "/orgs/{org}/custom_roles/{role_id}": { "get": { "summary": "Closing down - Get a custom role", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)\" endpoint instead.\n\nGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#get-a-custom-repository-role)\" endpoint instead.\n\nGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/get-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---get-a-custom-role" }, "parameters": [ { @@ -163990,14 +164904,14 @@ }, "patch": { "summary": "Closing down - Update a custom role", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)\" endpoint instead.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role)\" endpoint instead.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---update-a-custom-role" }, "parameters": [ { @@ -164393,14 +165307,14 @@ }, "delete": { "summary": "Closing down - Delete a custom role", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)\" endpoint instead.\n\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#delete-a-custom-repository-role)\" endpoint instead.\n\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---delete-a-custom-role" }, "parameters": [ { @@ -164448,7 +165362,7 @@ "operationId": "dependabot/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" }, "parameters": [ { @@ -164604,7 +165518,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -164613,7 +165527,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -164622,7 +165536,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -166502,7 +167416,7 @@ "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -167136,7 +168050,7 @@ "operationId": "dependabot/update-repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -167281,7 +168195,7 @@ "operationId": "dependabot/set-repository-access-default-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -167401,7 +168315,7 @@ "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { @@ -167415,7 +168329,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -167424,7 +168338,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -167550,7 +168464,7 @@ "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -167619,7 +168533,7 @@ "operationId": "dependabot/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-secret" }, "parameters": [ { @@ -167710,14 +168624,14 @@ }, "put": { "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -167748,7 +168662,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -167766,7 +168680,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "anyOf": [ { @@ -167839,7 +168753,7 @@ "operationId": "dependabot/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -167884,7 +168798,7 @@ "operationId": "dependabot/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -167907,7 +168821,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -167916,7 +168830,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -168802,14 +169716,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -168840,7 +169754,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -168878,14 +169792,14 @@ "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -168932,14 +169846,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -168995,7 +169909,7 @@ "operationId": "code-scanning/list-org-dismissal-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization" }, "x-github": { "githubCloudOnly": true, @@ -169074,7 +169988,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -169083,7 +169997,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -169536,7 +170450,7 @@ "operationId": "dependabot/list-dismissal-requests-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-an-organization" }, "x-github": { "githubCloudOnly": true, @@ -169617,7 +170531,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -169626,7 +170540,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -170012,7 +170926,7 @@ "operationId": "secret-scanning/list-org-dismissal-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org" }, "x-github": { "githubCloudOnly": true, @@ -170093,7 +171007,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -170102,7 +171016,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -170482,7 +171396,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { @@ -171607,7 +172521,7 @@ "operationId": "activity/list-public-org-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-organization-events" }, "parameters": [ { @@ -171621,7 +172535,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -171630,7 +172544,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -181941,14 +182855,14 @@ "/orgs/{org}/external-group/{group_id}": { "get": { "summary": "Get an external group", - "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/external-idp-group-info-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#get-an-external-group" }, "parameters": [ { @@ -181971,7 +182885,7 @@ }, { "name": "per_page", - "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -181980,7 +182894,7 @@ }, { "name": "page", - "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -182151,14 +183065,14 @@ "/orgs/{org}/external-groups": { "get": { "summary": "List external groups available to an organization", - "description": "Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-external-idp-groups-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#list-external-groups-available-to-an-organization" }, "parameters": [ { @@ -182172,7 +183086,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -182290,14 +183204,14 @@ "/orgs/{org}/failed_invitations": { "get": { "summary": "List failed organization invitations", - "description": "The return hash contains `failed_at` and `failed_reason` fields which\nrepresent the time at which the invitation failed and the reason for the failure.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", + "description": "The return hash contains `failed_at` and `failed_reason` fields which\nrepresent the time at which the invitation failed and the reason for the failure.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], "operationId": "orgs/list-failed-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-failed-organization-invitations" }, "parameters": [ { @@ -182311,7 +183225,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -182320,7 +183234,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -182607,14 +183521,14 @@ "/orgs/{org}/fine_grained_permissions": { "get": { "summary": "Closing down - List fine-grained permissions for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" endpoint instead.\n\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" endpoint instead.\n\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -182695,7 +183609,7 @@ "operationId": "orgs/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#list-organization-webhooks" }, "parameters": [ { @@ -182709,7 +183623,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -182718,7 +183632,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -182903,7 +183817,7 @@ "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#create-an-organization-webhook" }, "parameters": [ { @@ -182944,7 +183858,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -182974,7 +183888,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", "default": [ "push" ], @@ -183255,7 +184169,7 @@ "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-an-organization-webhook" }, "parameters": [ { @@ -183441,7 +184355,7 @@ "operationId": "orgs/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#update-an-organization-webhook" }, "parameters": [ { @@ -183487,7 +184401,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -183509,7 +184423,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -183773,7 +184687,7 @@ "operationId": "orgs/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#delete-an-organization-webhook" }, "parameters": [ { @@ -183844,7 +184758,7 @@ "operationId": "orgs/get-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -183889,7 +184803,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -183936,7 +184850,7 @@ "operationId": "orgs/update-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -183978,7 +184892,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -184032,7 +184946,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -184081,7 +184995,7 @@ "operationId": "orgs/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" }, "parameters": [ { @@ -184104,7 +185018,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -184416,7 +185330,7 @@ "operationId": "orgs/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -184785,7 +185699,7 @@ "operationId": "orgs/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -184979,7 +185893,7 @@ "operationId": "orgs/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#ping-an-organization-webhook" }, "parameters": [ { @@ -185050,7 +185964,7 @@ "operationId": "api-insights/get-route-stats-by-actor", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-route-stats-by-actor" }, "parameters": [ { @@ -185107,7 +186021,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -185116,7 +186030,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -185243,7 +186157,7 @@ "operationId": "api-insights/get-subject-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-subject-stats" }, "parameters": [ { @@ -185275,7 +186189,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -185284,7 +186198,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -185409,7 +186323,7 @@ "operationId": "api-insights/get-summary-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats" }, "parameters": [ { @@ -185491,7 +186405,7 @@ "operationId": "api-insights/get-summary-stats-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats-by-user" }, "parameters": [ { @@ -185582,7 +186496,7 @@ "operationId": "api-insights/get-summary-stats-by-actor", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats-by-actor" }, "parameters": [ { @@ -185689,7 +186603,7 @@ "operationId": "api-insights/get-time-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats" }, "parameters": [ { @@ -185812,7 +186726,7 @@ "operationId": "api-insights/get-time-stats-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats-by-user" }, "parameters": [ { @@ -185944,7 +186858,7 @@ "operationId": "api-insights/get-time-stats-by-actor", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats-by-actor" }, "parameters": [ { @@ -186092,7 +187006,7 @@ "operationId": "api-insights/get-user-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-user-stats" }, "parameters": [ { @@ -186133,7 +187047,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -186142,7 +187056,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -186271,14 +187185,14 @@ "/orgs/{org}/installation": { "get": { "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-org-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" }, "parameters": [ { @@ -187272,7 +188186,7 @@ "operationId": "orgs/list-app-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-app-installations-for-an-organization" }, "parameters": [ { @@ -187286,7 +188200,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -187295,7 +188209,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -188312,7 +189226,7 @@ "operationId": "interactions/get-restrictions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#get-interaction-restrictions-for-an-organization" }, "parameters": [ { @@ -188399,7 +189313,7 @@ "operationId": "interactions/set-restrictions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#set-interaction-restrictions-for-an-organization" }, "parameters": [ { @@ -188593,7 +189507,7 @@ "operationId": "interactions/remove-restrictions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization" }, "parameters": [ { @@ -188622,14 +189536,14 @@ "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", - "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud\nmember, the `login` field in the return hash will be `null`.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", + "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud\nmember, the `login` field in the return hash will be `null`.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], "operationId": "orgs/list-pending-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-pending-organization-invitations" }, "parameters": [ { @@ -188643,7 +189557,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -188652,7 +189566,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -188969,14 +189883,14 @@ }, "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 is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis 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": "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 is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis 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.", "tags": [ "orgs" ], "operationId": "orgs/create-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#create-an-organization-invitation" }, "parameters": [ { @@ -189373,14 +190287,14 @@ "/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 is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/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/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#cancel-an-organization-invitation" }, "parameters": [ { @@ -189514,14 +190428,14 @@ "/orgs/{org}/invitations/{invitation_id}/teams": { "get": { "summary": "List organization invitation teams", - "description": "List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", + "description": "List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], "operationId": "orgs/list-invitation-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-invitation-teams" }, "parameters": [ { @@ -189544,7 +190458,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -189553,7 +190467,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -189856,7 +190770,7 @@ "operationId": "orgs/list-issue-fields", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#list-issue-fields-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#list-issue-fields-for-an-organization" }, "parameters": [ { @@ -190073,14 +190987,14 @@ }, "post": { "summary": "Create issue field for an organization", - "description": "Creates a new issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates a new issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-issue-field", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#create-issue-field-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#create-issue-field-for-an-organization" }, "parameters": [ { @@ -190438,14 +191352,14 @@ "/orgs/{org}/issue-fields/{issue_field_id}": { "patch": { "summary": "Update issue field for an organization", - "description": "Updates an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Updates an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update-issue-field", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#update-issue-field-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#update-issue-field-for-an-organization" }, "parameters": [ { @@ -190818,14 +191732,14 @@ }, "delete": { "summary": "Delete issue field for an organization", - "description": "Deletes an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Deletes an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-issue-field", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#delete-issue-field-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#delete-issue-field-for-an-organization" }, "parameters": [ { @@ -190926,7 +191840,7 @@ "operationId": "orgs/list-issue-types", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#list-issue-types-for-an-organization" }, "parameters": [ { @@ -191068,14 +191982,14 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-issue-type", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#create-issue-type-for-an-organization" }, "parameters": [ { @@ -191290,14 +192204,14 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update-issue-type", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#update-issue-type-for-an-organization" }, "parameters": [ { @@ -191519,14 +192433,14 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-issue-type", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#delete-issue-type-for-an-organization" }, "parameters": [ { @@ -191620,14 +192534,14 @@ "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -191731,7 +192645,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -191740,7 +192654,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -195034,7 +195948,7 @@ "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -195048,7 +195962,7 @@ }, { "name": "filter", - "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", + "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", "in": "query", "required": false, "schema": { @@ -195078,7 +195992,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -195087,7 +196001,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -195352,7 +196266,7 @@ "operationId": "orgs/check-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#check-organization-membership-for-a-user" }, "parameters": [ { @@ -195409,7 +196323,7 @@ "operationId": "orgs/remove-member", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-an-organization-member" }, "parameters": [ { @@ -195480,12 +196394,12 @@ "operationId": "codespaces/get-codespaces-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -195494,7 +196408,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -197421,7 +198335,7 @@ "operationId": "codespaces/delete-from-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#delete-a-codespace-from-the-organization" }, "parameters": [ { @@ -197594,7 +198508,7 @@ "operationId": "codespaces/stop-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" }, "parameters": [ { @@ -199217,14 +200131,14 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/get-copilot-seat-details-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user" }, "parameters": [ { @@ -199968,7 +200882,7 @@ "operationId": "orgs/get-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-organization-membership-for-a-user" }, "parameters": [ { @@ -200380,14 +201294,14 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], "operationId": "orgs/set-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#set-organization-membership-for-a-user" }, "parameters": [ { @@ -200878,7 +201792,7 @@ "operationId": "orgs/remove-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-organization-membership-for-a-user" }, "parameters": [ { @@ -200975,7 +201889,7 @@ "operationId": "migrations/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#list-organization-migrations" }, "parameters": [ { @@ -200989,7 +201903,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -200998,7 +201912,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -202185,7 +203099,7 @@ "operationId": "migrations/start-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#start-an-organization-migration" }, "parameters": [ { @@ -203527,7 +204441,7 @@ "operationId": "migrations/get-status-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#get-an-organization-migration-status" }, "parameters": [ { @@ -204743,7 +205657,7 @@ "operationId": "migrations/download-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#download-an-organization-migration-archive" }, "parameters": [ { @@ -204812,7 +205726,7 @@ "operationId": "migrations/delete-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#delete-an-organization-migration-archive" }, "parameters": [ { @@ -204876,14 +205790,14 @@ "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { "delete": { "summary": "Unlock an organization repository", - "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", "tags": [ "migrations" ], "operationId": "migrations/unlock-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#unlock-an-organization-repository" }, "parameters": [ { @@ -204963,7 +205877,7 @@ "operationId": "migrations/list-repos-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#list-repositories-in-an-organization-migration" }, "parameters": [ { @@ -204986,7 +205900,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -204995,7 +205909,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -205954,14 +206868,14 @@ "/orgs/{org}/organization-fine-grained-permissions": { "get": { "summary": "List organization fine-grained permissions for an organization", - "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-organization-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -206123,14 +207037,14 @@ "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-org-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" }, "parameters": [ { @@ -206534,14 +207448,14 @@ }, "post": { "summary": "Create a custom organization role", - "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo include repository permissions in an organization role, you must also include the `base_role`\nfield, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.\n\nSee \"[List repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" for valid repository permissions.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo include repository permissions in an organization role, you must also include the `base_role`\nfield, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.\n\nSee \"[List repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" for valid repository permissions.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-custom-organization-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#create-a-custom-organization-role" }, "parameters": [ { @@ -206975,14 +207889,14 @@ "/orgs/{org}/organization-roles/teams/{team_slug}": { "delete": { "summary": "Remove all organization roles for a team", - "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/revoke-all-org-roles-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" }, "parameters": [ { @@ -207020,14 +207934,14 @@ "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { "put": { "summary": "Assign an organization role to a team", - "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/assign-team-to-org-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" }, "parameters": [ { @@ -207078,14 +207992,14 @@ }, "delete": { "summary": "Remove an organization role from a team", - "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/revoke-org-role-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" }, "parameters": [ { @@ -207132,14 +208046,14 @@ "/orgs/{org}/organization-roles/users/{username}": { "delete": { "summary": "Remove all organization roles for a user", - "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/revoke-all-org-roles-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user" }, "parameters": [ { @@ -207177,14 +208091,14 @@ "/orgs/{org}/organization-roles/users/{username}/{role_id}": { "put": { "summary": "Assign an organization role to a user", - "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/assign-user-to-org-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#assign-an-organization-role-to-a-user" }, "parameters": [ { @@ -207235,14 +208149,14 @@ }, "delete": { "summary": "Remove an organization role from a user", - "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/revoke-org-role-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-an-organization-role-from-a-user" }, "parameters": [ { @@ -207289,14 +208203,14 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/get-org-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#get-an-organization-role" }, "parameters": [ { @@ -207655,14 +208569,14 @@ }, "patch": { "summary": "Update a custom organization role", - "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nIf the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either\npreviously or as part of the update.\nIf the update sets the `base_role` field to `none`, you must also remove all of the repository\npermissions as well, otherwise the update will fail.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nIf the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either\npreviously or as part of the update.\nIf the update sets the `base_role` field to `none`, you must also remove all of the repository\npermissions as well, otherwise the update will fail.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/patch-custom-organization-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#update-a-custom-organization-role" }, "parameters": [ { @@ -208093,14 +209007,14 @@ }, "delete": { "summary": "Delete a custom organization role.", - "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-custom-organization-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#delete-a-custom-organization-role" }, "parameters": [ { @@ -208138,14 +209052,14 @@ "/orgs/{org}/organization-roles/{role_id}/teams": { "get": { "summary": "List teams that are assigned to an organization role", - "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-org-role-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" }, "parameters": [ { @@ -208168,7 +209082,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -208177,7 +209091,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -208464,14 +209378,14 @@ "/orgs/{org}/organization-roles/{role_id}/users": { "get": { "summary": "List users that are assigned to an organization role", - "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-org-role-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" }, "parameters": [ { @@ -208494,7 +209408,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -208503,7 +209417,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -208821,7 +209735,7 @@ "operationId": "orgs/list-outside-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" }, "parameters": [ { @@ -208835,7 +209749,7 @@ }, { "name": "filter", - "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned.", + "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned.", "in": "query", "required": false, "schema": { @@ -208850,7 +209764,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -208859,7 +209773,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -209048,14 +209962,14 @@ "/orgs/{org}/outside_collaborators/{username}": { "put": { "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest//articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "tags": [ "orgs" ], "operationId": "orgs/convert-member-to-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" }, "parameters": [ { @@ -209128,7 +210042,7 @@ "description": "User was converted" }, "403": { - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" }, "404": { "description": "Resource not found", @@ -209173,7 +210087,7 @@ "operationId": "orgs/remove-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" }, "parameters": [ { @@ -209218,7 +210132,7 @@ "response-if-user-is-a-member-of-the-organization": { "value": { "message": "You cannot specify an organization member to remove as an outside collaborator.", - "documentation_url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "documentation_url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" } } } @@ -209237,14 +210151,14 @@ "/orgs/{org}/packages": { "get": { "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-an-organization" }, "parameters": [ { @@ -209275,7 +210189,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor 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).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor 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).\"", "in": "query", "required": false, "schema": { @@ -209289,7 +210203,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -209298,7 +210212,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -210414,14 +211328,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-an-organization" }, "parameters": [ { @@ -211475,14 +212389,14 @@ }, "delete": { "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-an-organization" }, "parameters": [ { @@ -211615,14 +212529,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-an-organization" }, "parameters": [ { @@ -211764,14 +212678,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" }, "parameters": [ { @@ -211811,7 +212725,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -211820,7 +212734,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -212083,14 +212997,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-an-organization" }, "parameters": [ { @@ -212287,14 +213201,14 @@ }, "delete": { "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-package-version-for-an-organization" }, "parameters": [ { @@ -212436,14 +213350,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-package-version-for-an-organization" }, "parameters": [ { @@ -212592,7 +213506,7 @@ "operationId": "orgs/list-pat-grant-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -212606,7 +213520,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -212615,7 +213529,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -213164,7 +214078,7 @@ "operationId": "orgs/review-pat-grant-requests-in-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -213410,7 +214324,7 @@ "operationId": "orgs/review-pat-grant-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" }, "parameters": [ { @@ -213640,7 +214554,7 @@ "operationId": "orgs/list-pat-grant-request-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" }, "parameters": [ { @@ -213663,7 +214577,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -213672,7 +214586,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -214690,7 +215604,7 @@ "operationId": "orgs/list-pat-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" }, "parameters": [ { @@ -214704,7 +215618,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -214713,7 +215627,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -215255,7 +216169,7 @@ "operationId": "orgs/update-pat-accesses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -215495,7 +216409,7 @@ "operationId": "orgs/update-pat-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" }, "parameters": [ { @@ -215717,7 +216631,7 @@ "operationId": "orgs/list-pat-grant-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" }, "parameters": [ { @@ -215740,7 +216654,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -215749,7 +216663,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -216767,7 +217681,7 @@ "operationId": "private-registries/list-org-private-registries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#list-private-registries-for-an-organization" }, "parameters": [ { @@ -216781,7 +217695,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -216790,7 +217704,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -217079,14 +217993,14 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], "operationId": "private-registries/create-org-private-registry", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" }, "parameters": [ { @@ -217143,7 +218057,7 @@ "default": false }, "encrypted_value": { - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types.", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types.", "type": "string", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, @@ -217161,7 +218075,7 @@ ] }, "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", "type": "array", "items": { "type": "integer" @@ -217584,7 +218498,7 @@ "operationId": "private-registries/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" }, "parameters": [ { @@ -217685,7 +218599,7 @@ "operationId": "private-registries/get-org-private-registry", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" }, "parameters": [ { @@ -217900,14 +218814,14 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], "operationId": "private-registries/update-org-private-registry", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" }, "parameters": [ { @@ -217973,7 +218887,7 @@ "default": false }, "encrypted_value": { - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", "type": "string", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, @@ -218203,7 +219117,7 @@ "operationId": "private-registries/delete-org-private-registry", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" }, "parameters": [ { @@ -218334,7 +219248,7 @@ "operationId": "projects/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#list-projects-for-organization" }, "parameters": [ { @@ -218357,7 +219271,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -218366,7 +219280,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -218375,7 +219289,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -219222,7 +220136,7 @@ "operationId": "projects/get-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#get-project-for-organization" }, "parameters": [ { @@ -220080,7 +220994,7 @@ "operationId": "projects/create-draft-item-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-organization-owned-project" }, "parameters": [ { @@ -226809,7 +227723,7 @@ "operationId": "projects/list-fields-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#list-project-fields-for-organization" }, "parameters": [ { @@ -226832,7 +227746,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -226841,7 +227755,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -226850,7 +227764,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -227299,7 +228213,7 @@ "operationId": "projects/add-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#add-a-field-to-an-organization-owned-project" }, "parameters": [ { @@ -228036,7 +228950,7 @@ "operationId": "projects/get-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization" }, "parameters": [ { @@ -228398,7 +229312,7 @@ "operationId": "projects/list-items-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-an-organization-owned-project" }, "parameters": [ { @@ -228421,7 +229335,7 @@ }, { "name": "q", - "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", "in": "query", "required": false, "schema": { @@ -228450,7 +229364,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -228459,7 +229373,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -228468,7 +229382,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -229524,7 +230438,7 @@ "operationId": "projects/add-item-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#add-item-to-organization-owned-project" }, "parameters": [ { @@ -236495,7 +237409,7 @@ "operationId": "projects/get-org-item", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#get-an-item-for-an-organization-owned-project" }, "parameters": [ { @@ -237591,7 +238505,7 @@ "operationId": "projects/update-item-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#update-project-item-for-organization" }, "parameters": [ { @@ -241865,7 +242779,7 @@ "operationId": "projects/delete-item-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#delete-project-item-for-organization" }, "parameters": [ { @@ -241971,7 +242885,7 @@ "operationId": "projects/create-view-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-an-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-an-organization-owned-project" }, "parameters": [ { @@ -242017,7 +242931,7 @@ }, "filter": { "type": "string", - "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", "example": "is:issue is:open" }, "visible_fields": { @@ -242701,7 +243615,7 @@ "operationId": "projects/list-view-items-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-project-view" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-an-organization-project-view" }, "parameters": [ { @@ -242753,7 +243667,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -242762,7 +243676,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -242771,7 +243685,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -243855,7 +244769,7 @@ "operationId": "orgs/custom-properties-for-repos-get-organization-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization" }, "parameters": [ { @@ -244069,7 +244983,7 @@ "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization" }, "parameters": [ { @@ -244422,7 +245336,7 @@ "operationId": "orgs/custom-properties-for-repos-get-organization-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#get-a-custom-property-for-an-organization" }, "parameters": [ { @@ -244625,7 +245539,7 @@ "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" }, "parameters": [ { @@ -244917,7 +245831,7 @@ "operationId": "orgs/custom-properties-for-repos-delete-organization-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" }, "parameters": [ { @@ -245014,7 +245928,7 @@ "operationId": "orgs/custom-properties-for-repos-get-organization-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" }, "parameters": [ { @@ -245028,7 +245942,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -245037,7 +245951,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -245046,7 +245960,7 @@ }, { "name": "repository_query", - "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", "required": false, "schema": { @@ -245226,7 +246140,7 @@ "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" }, "parameters": [ { @@ -245466,7 +246380,7 @@ "operationId": "orgs/list-public-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-public-organization-members" }, "parameters": [ { @@ -245480,7 +246394,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -245489,7 +246403,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -245685,7 +246599,7 @@ "operationId": "orgs/check-public-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#check-public-organization-membership-for-a-user" }, "parameters": [ { @@ -245724,14 +246638,14 @@ }, "put": { "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "orgs" ], "operationId": "orgs/set-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -245800,7 +246714,7 @@ "operationId": "orgs/remove-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -245838,14 +246752,14 @@ "/orgs/{org}/repos": { "get": { "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], "operationId": "repos/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-organization-repositories" }, "parameters": [ { @@ -245905,7 +246819,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -245914,7 +246828,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -246852,7 +247766,7 @@ "operationId": "repos/create-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-an-organization-repository" }, "parameters": [ { @@ -246939,7 +247853,7 @@ }, "license_template": { "type": "string", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest//articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." }, "allow_squash_merge": { "type": "boolean", @@ -250942,14 +251856,14 @@ "/orgs/{org}/repository-fine-grained-permissions": { "get": { "summary": "List repository fine-grained permissions for an organization", - "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-repo-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -251027,7 +251941,7 @@ "operationId": "repos/get-org-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-all-organization-repository-rulesets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-all-organization-repository-rulesets" }, "x-github": { "githubCloudOnly": false, @@ -251047,7 +251961,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -251056,7 +251970,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -252317,7 +253231,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -252327,7 +253241,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -252506,7 +253420,7 @@ "operationId": "repos/create-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#create-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#create-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -253598,7 +254512,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -253608,7 +254522,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -254964,7 +255878,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -254974,7 +255888,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -255234,14 +256148,14 @@ "/orgs/{org}/rulesets/rule-suites": { "get": { "summary": "List organization rule suites", - "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "tags": [ "repos" ], "operationId": "repos/get-org-rule-suites", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites" }, "parameters": [ { @@ -255311,7 +256225,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -255320,7 +256234,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -255496,14 +256410,14 @@ "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { "get": { "summary": "Get an organization rule suite", - "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "tags": [ "repos" ], "operationId": "repos/get-org-rule-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite" }, "parameters": [ { @@ -255517,7 +256431,7 @@ }, { "name": "rule_suite_id", - "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", "in": "path", "required": true, "schema": { @@ -255771,7 +256685,7 @@ "operationId": "repos/get-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -257040,7 +257954,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -257050,7 +257964,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -257246,7 +258160,7 @@ "operationId": "repos/update-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#update-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#update-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -258346,7 +259260,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -258356,7 +259270,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -259708,7 +260622,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -259718,7 +260632,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -259983,7 +260897,7 @@ "operationId": "repos/delete-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#delete-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#delete-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -260080,7 +260994,7 @@ "operationId": "orgs/get-org-ruleset-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-organization-ruleset-history" }, "parameters": [ { @@ -260094,7 +261008,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -260103,7 +261017,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -260264,7 +261178,7 @@ "operationId": "orgs/get-org-ruleset-version", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-organization-ruleset-version" }, "parameters": [ { @@ -260479,7 +261393,7 @@ "operationId": "secret-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -260507,7 +261421,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -260516,7 +261430,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -260602,7 +261516,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -260611,7 +261525,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -260620,7 +261534,7 @@ }, { "name": "before", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -260629,7 +261543,7 @@ }, { "name": "after", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -260877,7 +261791,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -262489,7 +263403,7 @@ "operationId": "secret-scanning/list-org-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-organization-pattern-configurations" }, "x-github": { "githubCloudOnly": false, @@ -262774,7 +263688,7 @@ "operationId": "secret-scanning/update-org-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#update-organization-pattern-configurations" }, "x-github": { "githubCloudOnly": false, @@ -263122,7 +264036,7 @@ "operationId": "security-advisories/list-org-repository-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" }, "parameters": [ { @@ -263165,7 +264079,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -263174,7 +264088,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -263183,7 +264097,7 @@ }, { "name": "per_page", - "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -265330,14 +266244,14 @@ "/orgs/{org}/security-managers": { "get": { "summary": "List security manager teams", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], "operationId": "orgs/list-security-manager-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#list-security-manager-teams" }, "parameters": [ { @@ -265501,14 +266415,14 @@ "/orgs/{org}/security-managers/teams/{team_slug}": { "put": { "summary": "Add a security manager team", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], "operationId": "orgs/add-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#add-a-security-manager-team" }, "parameters": [ { @@ -265548,14 +266462,14 @@ }, "delete": { "summary": "Remove a security manager team", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], "operationId": "orgs/remove-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#remove-a-security-manager-team" }, "parameters": [ { @@ -265604,7 +266518,7 @@ "operationId": "billing/get-github-advanced-security-billing-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" }, "parameters": [ { @@ -265631,7 +266545,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -265640,7 +266554,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -265785,7 +266699,7 @@ "operationId": "orgs/get-immutable-releases-settings", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization" }, "parameters": [ { @@ -265854,7 +266768,7 @@ "operationId": "orgs/set-immutable-releases-settings", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization" }, "parameters": [ { @@ -265891,7 +266805,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", + "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", "items": { "type": "integer" } @@ -265929,7 +266843,7 @@ "operationId": "orgs/get-immutable-releases-settings-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement" }, "parameters": [ { @@ -265943,7 +266857,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -265952,7 +266866,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -266845,7 +267759,7 @@ "operationId": "orgs/set-immutable-releases-settings-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement" }, "parameters": [ { @@ -266867,7 +267781,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", + "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", "items": { "type": "integer" } @@ -266912,7 +267826,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization" }, "parameters": [ { @@ -266955,7 +267869,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization" }, "parameters": [ { @@ -267000,7 +267914,7 @@ "operationId": "hosted-compute/list-network-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" }, "parameters": [ { @@ -267014,7 +267928,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -267023,7 +267937,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -267167,7 +268081,7 @@ "operationId": "hosted-compute/create-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -267341,7 +268255,7 @@ "operationId": "hosted-compute/get-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -267469,7 +268383,7 @@ "operationId": "hosted-compute/update-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -267646,7 +268560,7 @@ "operationId": "hosted-compute/delete-network-configuration-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" }, "parameters": [ { @@ -267691,7 +268605,7 @@ "operationId": "hosted-compute/get-network-settings-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" }, "parameters": [ { @@ -267797,7 +268711,7 @@ "operationId": "teams/list-idp-groups-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-an-organization" }, "parameters": [ { @@ -267811,7 +268725,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -267947,7 +268861,7 @@ "operationId": "copilot/copilot-metrics-for-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" }, "parameters": [ { @@ -267988,7 +268902,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -267997,7 +268911,7 @@ }, { "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -268596,7 +269510,7 @@ "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-teams" }, "parameters": [ { @@ -268610,7 +269524,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -268619,7 +269533,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -268628,7 +269542,7 @@ }, { "name": "team_type", - "description": "Filter team results by their type. For more information, see \"[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)\"", + "description": "Filter team results by their type. For more information, see \"[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)\"", "in": "query", "required": false, "schema": { @@ -268928,14 +269842,14 @@ }, "post": { "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest//articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ "teams" ], "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team" }, "parameters": [ { @@ -269702,7 +270616,7 @@ "operationId": "teams/get-by-name", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-by-name" }, "parameters": [ { @@ -270330,7 +271244,7 @@ "operationId": "teams/update-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team" }, "parameters": [ { @@ -271676,7 +272590,7 @@ "operationId": "teams/delete-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team" }, "parameters": [ { @@ -271717,14 +272631,14 @@ "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -271833,14 +272747,14 @@ }, "patch": { "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/link-external-idp-group-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -272053,14 +272967,14 @@ }, "delete": { "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/unlink-external-idp-group-from-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -272108,7 +273022,7 @@ "operationId": "teams/list-pending-invitations-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations" }, "parameters": [ { @@ -272131,7 +273045,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -272140,7 +273054,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -272411,7 +273325,7 @@ "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members" }, "parameters": [ { @@ -272449,7 +273363,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -272458,7 +273372,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -272647,14 +273561,14 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user" }, "parameters": [ { @@ -272750,14 +273664,14 @@ }, "put": { "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -272885,14 +273799,14 @@ }, "delete": { "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -272949,7 +273863,7 @@ "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -272972,7 +273886,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -272981,7 +273895,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -273914,14 +274828,14 @@ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -274782,14 +275696,14 @@ }, "put": { "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note 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 method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions" }, "parameters": [ { @@ -274874,7 +275788,7 @@ "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team" }, "parameters": [ { @@ -274930,14 +275844,14 @@ "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { "get": { "summary": "List IdP groups for a team", - "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", + "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], "operationId": "teams/list-idp-groups-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team" }, "parameters": [ { @@ -275057,14 +275971,14 @@ }, "patch": { "summary": "Create or update IdP group connections", - "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", + "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], "operationId": "teams/create-or-update-idp-group-connections-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections" }, "parameters": [ { @@ -275245,7 +276159,7 @@ "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -275268,7 +276182,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -275277,7 +276191,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -275560,14 +276474,14 @@ "/orgs/{org}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -275658,14 +276572,14 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, "parameters": [], "responses": { @@ -276150,14 +277064,14 @@ "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ "repos" ], "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository" }, "parameters": [ { @@ -280085,14 +280999,14 @@ }, "patch": { "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics) endpoint.", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics) endpoint.", "tags": [ "repos" ], "operationId": "repos/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository" }, "parameters": [ { @@ -280135,7 +281049,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-cloud@latest/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -280149,7 +281063,7 @@ }, "security_and_analysis": { "type": "object", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "nullable": true, "properties": { "advanced_security": { @@ -280194,7 +281108,7 @@ }, "secret_scanning_ai_detection": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", + "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", "properties": { "status": { "type": "string", @@ -284370,7 +285284,7 @@ "operationId": "repos/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository" }, "parameters": [ { @@ -284415,7 +285329,7 @@ "default": { "value": { "message": "Organization members cannot delete repositories.", - "documentation_url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository" + "documentation_url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository" } } } @@ -284519,7 +285433,7 @@ "operationId": "actions/list-artifacts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository" }, "parameters": [ { @@ -284542,7 +285456,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -284551,7 +285465,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -284763,7 +285677,7 @@ "operationId": "actions/get-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact" }, "parameters": [ { @@ -284939,7 +285853,7 @@ "operationId": "actions/delete-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact" }, "parameters": [ { @@ -284993,7 +285907,7 @@ "operationId": "actions/download-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact" }, "parameters": [ { @@ -285089,7 +286003,7 @@ "operationId": "actions/get-actions-cache-retention-limit-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" }, "parameters": [ { @@ -285207,7 +286121,7 @@ "operationId": "actions/set-actions-cache-retention-limit-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" }, "parameters": [ { @@ -285390,7 +286304,7 @@ "operationId": "actions/get-actions-cache-storage-limit-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" }, "parameters": [ { @@ -285508,7 +286422,7 @@ "operationId": "actions/set-actions-cache-storage-limit-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" }, "parameters": [ { @@ -285691,7 +286605,7 @@ "operationId": "actions/get-actions-cache-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" }, "parameters": [ { @@ -285776,7 +286690,7 @@ "operationId": "actions/get-actions-cache-list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-github-actions-caches-for-a-repository" }, "parameters": [ { @@ -285799,7 +286713,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -285808,7 +286722,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -285970,7 +286884,7 @@ "operationId": "actions/delete-actions-cache-by-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" }, "parameters": [ { @@ -286110,7 +287024,7 @@ "operationId": "actions/delete-actions-cache-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" }, "parameters": [ { @@ -286164,7 +287078,7 @@ "operationId": "actions/get-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" }, "parameters": [ { @@ -286559,7 +287473,7 @@ "operationId": "actions/download-job-logs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" }, "parameters": [ { @@ -286621,7 +287535,7 @@ "operationId": "actions/re-run-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" }, "parameters": [ { @@ -286740,7 +287654,7 @@ "operationId": "actions/get-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -286782,6 +287696,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -286905,7 +287827,7 @@ "operationId": "actions/set-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -286949,6 +287871,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -287121,7 +288047,7 @@ "operationId": "actions/list-repo-organization-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets" }, "parameters": [ { @@ -287144,7 +288070,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -287153,7 +288079,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -287255,7 +288181,7 @@ "operationId": "actions/list-repo-organization-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables" }, "parameters": [ { @@ -287278,7 +288204,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -287287,7 +288213,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -287400,7 +288326,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -287486,7 +288412,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -287565,14 +288491,14 @@ "/repos/{owner}/{repo}/actions/permissions/access": { "get": { "summary": "Get the level of access for workflows outside of the repository", - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -287638,14 +288564,14 @@ }, "put": { "summary": "Set the level of access for workflows outside of the repository", - "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -287723,7 +288649,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" }, "parameters": [ { @@ -287820,7 +288746,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" }, "parameters": [ { @@ -287986,7 +288912,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" }, "parameters": [ { @@ -288082,7 +289008,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" }, "parameters": [ { @@ -288253,7 +289179,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" }, "parameters": [ { @@ -288388,7 +289314,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" }, "parameters": [ { @@ -288568,7 +289494,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -288647,7 +289573,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -288724,14 +289650,14 @@ "/repos/{owner}/{repo}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for a repository", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -288801,14 +289727,14 @@ }, "put": { "summary": "Set default workflow permissions for a repository", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -288889,7 +289815,7 @@ "operationId": "actions/list-self-hosted-runners-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" }, "parameters": [ { @@ -288920,7 +289846,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -288929,7 +289855,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -289126,7 +290052,7 @@ "operationId": "actions/list-runner-applications-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" }, "parameters": [ { @@ -289246,7 +290172,7 @@ "operationId": "actions/generate-runner-jitconfig-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" }, "parameters": [ { @@ -289555,7 +290481,7 @@ "operationId": "actions/create-registration-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" }, "parameters": [ { @@ -290402,7 +291328,7 @@ "operationId": "actions/create-remove-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" }, "parameters": [ { @@ -291249,7 +292175,7 @@ "operationId": "actions/get-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -291414,7 +292340,7 @@ "operationId": "actions/delete-self-hosted-runner-from-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" }, "parameters": [ { @@ -291498,7 +292424,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -291650,7 +292576,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -291866,7 +292792,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -292082,7 +293008,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -292231,7 +293157,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -292417,14 +293343,14 @@ "/repos/{owner}/{repo}/actions/runs": { "get": { "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" }, "parameters": [ { @@ -292465,7 +293391,7 @@ }, { "name": "event", - "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).\"", + "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).\"", "in": "query", "required": false, "schema": { @@ -292499,7 +293425,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -292508,7 +293434,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -292517,7 +293443,7 @@ }, { "name": "created", - "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).\"", + "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).\"", "in": "query", "required": false, "schema": { @@ -294994,7 +295920,7 @@ "operationId": "actions/get-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run" }, "parameters": [ { @@ -297463,7 +298389,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run" }, "parameters": [ { @@ -297517,7 +298443,7 @@ "operationId": "actions/get-reviews-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" }, "parameters": [ { @@ -297807,14 +298733,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { "post": { "summary": "Approve a workflow run for a fork pull request", - "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/approve-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request" }, "parameters": [ { @@ -297936,7 +298862,7 @@ "operationId": "actions/list-workflow-run-artifacts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts" }, "parameters": [ { @@ -297968,7 +298894,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -297977,7 +298903,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -298203,7 +299129,7 @@ "operationId": "actions/get-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt" }, "parameters": [ { @@ -300676,14 +301602,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { "get": { "summary": "List jobs for a workflow run attempt", - "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" }, "parameters": [ { @@ -300724,7 +301650,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -300733,7 +301659,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -301159,7 +302085,7 @@ "operationId": "actions/download-workflow-run-attempt-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs" }, "parameters": [ { @@ -301230,7 +302156,7 @@ "operationId": "actions/cancel-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run" }, "parameters": [ { @@ -301319,14 +302245,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/review-custom-gates-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" }, "parameters": [ { @@ -301443,7 +302369,7 @@ "operationId": "actions/force-cancel-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run" }, "parameters": [ { @@ -301532,14 +302458,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { "get": { "summary": "List jobs for a workflow run", - "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" }, "parameters": [ { @@ -301585,7 +302511,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -301594,7 +302520,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -301994,7 +302920,7 @@ "operationId": "actions/download-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs" }, "parameters": [ { @@ -302054,7 +302980,7 @@ "operationId": "actions/delete-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs" }, "parameters": [ { @@ -302160,7 +303086,7 @@ "operationId": "actions/get-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -302695,7 +303621,7 @@ "operationId": "actions/review-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -303395,7 +304321,7 @@ "operationId": "actions/re-run-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow" }, "parameters": [ { @@ -303488,7 +304414,7 @@ "operationId": "actions/re-run-workflow-failed-jobs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" }, "parameters": [ { @@ -303574,14 +304500,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { "get": { "summary": "Get workflow run usage", - "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/get-workflow-run-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage" }, "parameters": [ { @@ -303811,7 +304737,7 @@ "operationId": "actions/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets" }, "parameters": [ { @@ -303834,7 +304760,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -303843,7 +304769,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -303945,7 +304871,7 @@ "operationId": "actions/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -304039,7 +304965,7 @@ "operationId": "actions/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret" }, "parameters": [ { @@ -304122,14 +305048,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -304169,7 +305095,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -304233,7 +305159,7 @@ "operationId": "actions/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -304287,7 +305213,7 @@ "operationId": "actions/list-repo-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables" }, "parameters": [ { @@ -304310,7 +305236,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -304319,7 +305245,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -304430,7 +305356,7 @@ "operationId": "actions/create-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable" }, "parameters": [ { @@ -304523,7 +305449,7 @@ "operationId": "actions/get-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable" }, "parameters": [ { @@ -304623,7 +305549,7 @@ "operationId": "actions/update-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable" }, "parameters": [ { @@ -304703,7 +305629,7 @@ "operationId": "actions/delete-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable" }, "parameters": [ { @@ -304757,7 +305683,7 @@ "operationId": "actions/list-repo-workflows", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows" }, "parameters": [ { @@ -304780,7 +305706,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -304789,7 +305715,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -304953,7 +305879,7 @@ "operationId": "actions/get-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow" }, "parameters": [ { @@ -305107,7 +306033,7 @@ "operationId": "actions/disable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow" }, "parameters": [ { @@ -305168,7 +306094,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event" }, "parameters": [ { @@ -305312,7 +306238,7 @@ "operationId": "actions/enable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow" }, "parameters": [ { @@ -305366,14 +306292,14 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs for a workflow", - "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" }, "parameters": [ { @@ -305430,7 +306356,7 @@ }, { "name": "event", - "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).\"", + "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).\"", "in": "query", "required": false, "schema": { @@ -305464,7 +306390,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -305473,7 +306399,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -305482,7 +306408,7 @@ }, { "name": "created", - "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).\"", + "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).\"", "in": "query", "required": false, "schema": { @@ -307952,14 +308878,14 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/get-workflow-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage" }, "parameters": [ { @@ -308073,14 +308999,14 @@ "/repos/{owner}/{repo}/activity": { "get": { "summary": "List repository activities", - "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository).\"", + "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/viewing-activity-and-data-for-your-repository).\"", "tags": [ "repos" ], "operationId": "repos/list-activities", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities" }, "parameters": [ { @@ -308117,7 +309043,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -308126,7 +309052,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -308135,7 +309061,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -308474,14 +309400,14 @@ "/repos/{owner}/{repo}/assignees": { "get": { "summary": "List assignees", - "description": "Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest//articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "tags": [ "issues" ], "operationId": "issues/list-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees" }, "parameters": [ { @@ -308504,7 +309430,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -308513,7 +309439,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -308735,7 +309661,7 @@ "operationId": "issues/check-user-can-be-assigned", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned" }, "parameters": [ { @@ -308807,14 +309733,14 @@ "/repos/{owner}/{repo}/attestations": { "post": { "summary": "Create an attestation", - "description": "Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "repos" ], "operationId": "repos/create-attestation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation" }, "parameters": [ { @@ -309065,14 +309991,14 @@ "/repos/{owner}/{repo}/attestations/{subject_digest}": { "get": { "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "repos" ], "operationId": "repos/list-attestations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations" }, "parameters": [ { @@ -309095,7 +310021,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -309104,7 +310030,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -309113,7 +310039,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -309338,7 +310264,7 @@ "operationId": "repos/list-autolinks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository" }, "parameters": [ { @@ -309437,7 +310363,7 @@ "operationId": "repos/create-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" }, "parameters": [ { @@ -309648,7 +310574,7 @@ "operationId": "repos/get-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" }, "parameters": [ { @@ -309777,7 +310703,7 @@ "operationId": "repos/delete-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" }, "parameters": [ { @@ -309850,14 +310776,14 @@ "/repos/{owner}/{repo}/automated-security-fixes": { "get": { "summary": "Check if Dependabot security updates are enabled for a repository", - "description": "Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)\".", + "description": "Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)\".", "tags": [ "repos" ], "operationId": "repos/check-automated-security-fixes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository" }, "parameters": [ { @@ -309929,14 +310855,14 @@ }, "put": { "summary": "Enable Dependabot security updates", - "description": "Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)\".", + "description": "Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)\".", "tags": [ "repos" ], "operationId": "repos/enable-automated-security-fixes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates" }, "parameters": [ { @@ -309972,14 +310898,14 @@ }, "delete": { "summary": "Disable Dependabot security updates", - "description": "Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)\".", + "description": "Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)\".", "tags": [ "repos" ], "operationId": "repos/disable-automated-security-fixes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates" }, "parameters": [ { @@ -310024,7 +310950,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches" }, "parameters": [ { @@ -310056,7 +310982,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -310065,7 +310991,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -312196,7 +313122,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -312219,7 +313145,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -315000,14 +315926,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection": { "get": { "summary": "Get branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -315030,7 +315956,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -317287,14 +318213,14 @@ }, "put": { "summary": "Update branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", "tags": [ "repos" ], "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -317317,7 +318243,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -317419,7 +318345,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) review them." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest/articles/about-code-owners/) review them." }, "required_approving_review_count": { "type": "integer", @@ -317493,16 +318419,16 @@ }, "required_linear_history": { "type": "boolean", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." }, "allow_force_pushes": { "type": "boolean", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", "nullable": true }, "allow_deletions": { "type": "boolean", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." }, "block_creations": { "type": "boolean", @@ -319769,14 +320695,14 @@ }, "delete": { "summary": "Delete branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -319799,7 +320725,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -319850,14 +320776,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { "get": { "summary": "Get admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -319880,7 +320806,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -319935,14 +320861,14 @@ }, "post": { "summary": "Set admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -319965,7 +320891,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -320020,14 +320946,14 @@ }, "delete": { "summary": "Delete admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -320050,7 +320976,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -320101,14 +321027,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { "get": { "summary": "Get pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -320131,7 +321057,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -321619,14 +322545,14 @@ }, "patch": { "summary": "Update pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", "tags": [ "repos" ], "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -321649,7 +322575,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -321698,7 +322624,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) have reviewed." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { "type": "integer", @@ -323321,14 +324247,14 @@ }, "delete": { "summary": "Delete pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -323351,7 +324277,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -323402,14 +324328,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "get": { "summary": "Get commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -323432,7 +324358,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -323513,14 +324439,14 @@ }, "post": { "summary": "Create commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -323543,7 +324469,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -323624,14 +324550,14 @@ }, "delete": { "summary": "Delete commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -323654,7 +324580,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -323705,14 +324631,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { "get": { "summary": "Get status checks protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -323735,7 +324661,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -323857,14 +324783,14 @@ }, "patch": { "summary": "Update status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -323887,7 +324813,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -324132,14 +325058,14 @@ }, "delete": { "summary": "Remove status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -324162,7 +325088,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -324187,14 +325113,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { "get": { "summary": "Get all status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -324217,7 +325143,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -324283,14 +325209,14 @@ }, "post": { "summary": "Add status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -324313,7 +325239,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -324525,14 +325451,14 @@ }, "put": { "summary": "Set status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -324555,7 +325481,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -324739,14 +325665,14 @@ }, "delete": { "summary": "Remove status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -324769,7 +325695,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -324954,14 +325880,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "get": { "summary": "Get access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "tags": [ "repos" ], "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -324984,7 +325910,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -325584,14 +326510,14 @@ }, "delete": { "summary": "Delete access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", "tags": [ "repos" ], "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -325614,7 +326540,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -325639,14 +326565,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { "get": { "summary": "Get apps with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -325669,7 +326595,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -326081,14 +327007,14 @@ }, "post": { "summary": "Add app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -326111,7 +327037,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -326603,14 +327529,14 @@ }, "put": { "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -326633,7 +327559,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -327125,14 +328051,14 @@ }, "delete": { "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -327155,7 +328081,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -327649,14 +328575,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { "get": { "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -327679,7 +328605,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -327966,14 +328892,14 @@ }, "post": { "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", "tags": [ "repos" ], "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -327996,7 +328922,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -328375,14 +329301,14 @@ }, "put": { "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", "tags": [ "repos" ], "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -328405,7 +329331,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -328784,14 +329710,14 @@ }, "delete": { "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", "tags": [ "repos" ], "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -328814,7 +329740,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -329194,14 +330120,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { "get": { "summary": "Get users with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", "tags": [ "repos" ], "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -329224,7 +330150,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -329430,14 +330356,14 @@ }, "post": { "summary": "Add user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -329460,7 +330386,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -329747,14 +330673,14 @@ }, "put": { "summary": "Set user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -329777,7 +330703,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -330064,14 +330990,14 @@ }, "delete": { "summary": "Remove user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -330094,7 +331020,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -330383,14 +331309,14 @@ "/repos/{owner}/{repo}/branches/{branch}/rename": { "post": { "summary": "Rename a branch", - "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "tags": [ "repos" ], "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -330413,7 +331339,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -333295,7 +334221,7 @@ "operationId": "repos/list-repo-push-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#list-repository-push-rule-bypass-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/bypass-requests#list-repository-push-rule-bypass-requests" }, "x-github": { "githubCloudOnly": true, @@ -333378,7 +334304,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -333387,7 +334313,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -333750,7 +334676,7 @@ "operationId": "repos/get-repo-push-bypass-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#get-a-repository-push-bypass-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/bypass-requests#get-a-repository-push-bypass-request" }, "x-github": { "githubCloudOnly": true, @@ -334094,7 +335020,7 @@ "operationId": "secret-scanning/list-repo-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -334177,7 +335103,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -334186,7 +335112,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -334574,7 +335500,7 @@ "operationId": "secret-scanning/get-bypass-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -334940,7 +335866,7 @@ "operationId": "secret-scanning/review-bypass-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -335197,7 +336123,7 @@ "operationId": "secret-scanning/dismiss-bypass-response", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -335398,7 +336324,7 @@ "operationId": "checks/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run" }, "parameters": [ { @@ -335500,7 +336426,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)\".", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -335589,7 +336515,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -336882,7 +337808,7 @@ "operationId": "checks/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run" }, "parameters": [ { @@ -337977,7 +338903,7 @@ "operationId": "checks/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run" }, "parameters": [ { @@ -338083,7 +339009,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)\".", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -338171,7 +339097,7 @@ }, "actions": { "type": "array", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -339338,7 +340264,7 @@ "operationId": "checks/list-annotations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations" }, "parameters": [ { @@ -339370,7 +340296,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -339379,7 +340305,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -339500,14 +340426,14 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".", "tags": [ "checks" ], "operationId": "checks/rerequest-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run" }, "parameters": [ { @@ -339648,14 +340574,14 @@ "/repos/{owner}/{repo}/check-suites": { "post": { "summary": "Create a check suite", - "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/create-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite" }, "parameters": [ { @@ -343072,14 +343998,14 @@ "/repos/{owner}/{repo}/check-suites/preferences": { "patch": { "summary": "Update repository preferences for check suites", - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", "tags": [ "checks" ], "operationId": "checks/set-suites-preferences", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites" }, "parameters": [ { @@ -344218,7 +345144,7 @@ "operationId": "checks/get-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite" }, "parameters": [ { @@ -345947,7 +346873,7 @@ "operationId": "checks/list-for-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-in-a-check-suite" }, "parameters": [ { @@ -346016,7 +346942,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -346025,7 +346951,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -347120,14 +348046,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { "post": { "summary": "Rerequest a check suite", - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.", "tags": [ "checks" ], "operationId": "checks/rerequest-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite" }, "parameters": [ { @@ -347197,7 +348123,7 @@ "operationId": "code-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -347241,7 +348167,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -347250,7 +348176,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -347292,7 +348218,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -347301,7 +348227,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -348231,7 +349157,7 @@ "operationId": "code-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-alert" }, "parameters": [ { @@ -349078,7 +350004,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-alert" }, "parameters": [ { @@ -350053,7 +350979,7 @@ "operationId": "code-scanning/get-autofix", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert" }, "parameters": [ { @@ -350259,7 +351185,7 @@ "operationId": "code-scanning/create-autofix", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert" }, "parameters": [ { @@ -350517,7 +351443,7 @@ "operationId": "code-scanning/commit-autofix", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert" }, "parameters": [ { @@ -350739,7 +351665,7 @@ "operationId": "code-scanning/list-alert-instances", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" }, "parameters": [ { @@ -350773,7 +351699,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -350782,7 +351708,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -351040,7 +351966,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" }, "parameters": [ { @@ -351084,7 +352010,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -351093,7 +352019,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -351406,14 +352332,14 @@ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { "get": { "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" }, "parameters": [ { @@ -351757,7 +352683,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" }, "parameters": [ { @@ -351992,7 +352918,7 @@ "operationId": "code-scanning/list-codeql-databases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository" }, "parameters": [ { @@ -352361,14 +353287,14 @@ "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { "get": { "summary": "Get a CodeQL database for a repository", - "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], "operationId": "code-scanning/get-codeql-database", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository" }, "parameters": [ { @@ -352718,7 +353644,7 @@ "operationId": "code-scanning/delete-codeql-database", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database" }, "parameters": [ { @@ -352839,14 +353765,14 @@ "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { "post": { "summary": "Create a CodeQL variant analysis", - "description": "Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest//code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "code-scanning" ], "operationId": "code-scanning/create-variant-analysis", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis" }, "parameters": [ { @@ -354531,7 +355457,7 @@ "operationId": "code-scanning/get-variant-analysis", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis" }, "parameters": [ { @@ -355732,7 +356658,7 @@ "operationId": "code-scanning/get-variant-analysis-repo-task", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis" }, "parameters": [ { @@ -356400,7 +357326,7 @@ "operationId": "code-scanning/get-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -356615,7 +357541,7 @@ "operationId": "code-scanning/update-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -356901,14 +357827,14 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" }, "parameters": [ { @@ -356951,7 +357877,7 @@ "example": "refs/heads/main" }, "sarif": { - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secure-coding/sarif-support-for-code-scanning).\"", + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secure-coding/sarif-support-for-code-scanning).\"", "type": "string" }, "checkout_uri": { @@ -357124,7 +358050,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" }, "parameters": [ { @@ -357271,7 +358197,7 @@ "operationId": "code-security/get-configuration-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository" }, "parameters": [ { @@ -357723,14 +358649,14 @@ "/repos/{owner}/{repo}/codeowners/errors": { "get": { "summary": "List CODEOWNERS errors", - "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", + "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", "tags": [ "repos" ], "operationId": "repos/codeowners-errors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors" }, "parameters": [ { @@ -357879,12 +358805,12 @@ "operationId": "codespaces/list-in-repository-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -357893,7 +358819,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -359672,7 +360598,7 @@ "operationId": "codespaces/create-with-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository" }, "parameters": [ { @@ -362888,12 +363814,12 @@ "operationId": "codespaces/list-devcontainers-in-repository-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -362902,7 +363828,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -363174,7 +364100,7 @@ "operationId": "codespaces/repo-machines-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-available-machine-types-for-a-repository" }, "parameters": [ { @@ -363453,7 +364379,7 @@ "operationId": "codespaces/pre-flight-with-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace" }, "parameters": [ { @@ -363773,7 +364699,7 @@ "operationId": "codespaces/check-permissions-for-devcontainer", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user" }, "parameters": [ { @@ -364032,7 +364958,7 @@ "operationId": "codespaces/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets" }, "parameters": [ { @@ -364055,7 +364981,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -364064,7 +364990,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -364168,7 +365094,7 @@ "operationId": "codespaces/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key" }, "parameters": [ { @@ -364262,7 +365188,7 @@ "operationId": "codespaces/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret" }, "parameters": [ { @@ -364346,14 +365272,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.", + "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.", "tags": [ "codespaces" ], "operationId": "codespaces/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -364393,7 +365319,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -364453,7 +365379,7 @@ "operationId": "codespaces/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret" }, "parameters": [ { @@ -364507,7 +365433,7 @@ "operationId": "repos/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators" }, "parameters": [ { @@ -364561,7 +365487,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -364570,7 +365496,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -364826,7 +365752,7 @@ "operationId": "repos/check-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" }, "parameters": [ { @@ -364874,14 +365800,14 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)\" to learn more about these collaborator types.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\n\nAdding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)\" and \"[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)\" for organization settings.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\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 [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations).\n\nFor Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou 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": "Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)\" to learn more about these collaborator types.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications).\n\nAdding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)\" and \"[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)\" for organization settings.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\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 method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"\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 [API](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations).\n\nFor Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou 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": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator" }, "parameters": [ { @@ -366249,14 +367175,14 @@ }, "delete": { "summary": "Remove a repository collaborator", - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations sent by the collaborator\n- Unassigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations sent by the collaborator\n- Unassigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "tags": [ "repos" ], "operationId": "repos/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator" }, "parameters": [ { @@ -366405,7 +367331,7 @@ "operationId": "repos/get-collaborator-permission-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user" }, "parameters": [ { @@ -366680,14 +367606,14 @@ "/repos/{owner}/{repo}/comments": { "get": { "summary": "List commit comments for a repository", - "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-commit-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository" }, "parameters": [ { @@ -366710,7 +367636,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -366719,7 +367645,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -367050,14 +367976,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}": { "get": { "summary": "Get a commit comment", - "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/get-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment" }, "parameters": [ { @@ -367423,14 +368349,14 @@ }, "patch": { "summary": "Update a commit comment", - "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/update-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment" }, "parameters": [ { @@ -367829,7 +368755,7 @@ "operationId": "repos/delete-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment" }, "parameters": [ { @@ -367903,14 +368829,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a commit comment", - "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment).", + "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment" }, "parameters": [ { @@ -367943,7 +368869,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", "in": "query", "required": false, "schema": { @@ -367962,7 +368888,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -367971,7 +368897,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -368233,14 +369159,14 @@ }, "post": { "summary": "Create reaction for a commit comment", - "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", + "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment" }, "parameters": [ { @@ -368281,7 +369207,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the commit comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the commit comment.", "enum": [ "+1", "-1", @@ -368798,14 +369724,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a commit comment reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction" }, "parameters": [ { @@ -368869,7 +369795,7 @@ "operationId": "repos/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits" }, "parameters": [ { @@ -368948,7 +369874,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -368957,7 +369883,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -369767,14 +370693,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { "get": { "summary": "List branches for HEAD commit", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "tags": [ "repos" ], "operationId": "repos/list-branches-for-head-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit" }, "parameters": [ { @@ -369971,14 +370897,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { "get": { "summary": "List commit comments", - "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-comments-for-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments" }, "parameters": [ { @@ -370011,7 +370937,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -370020,7 +370946,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -370349,14 +371275,14 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/create-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment" }, "parameters": [ { @@ -370850,7 +371776,7 @@ "operationId": "repos/list-pull-requests-associated-with-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-pull-requests-associated-with-a-commit" }, "parameters": [ { @@ -370883,7 +371809,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -370892,7 +371818,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -374693,14 +375619,14 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit" }, "parameters": [ { @@ -374723,7 +375649,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -374732,7 +375658,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -375616,14 +376542,14 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-for-a-git-reference" }, "parameters": [ { @@ -375693,7 +376619,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -375702,7 +376628,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -376812,7 +377738,7 @@ "operationId": "checks/list-suites-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#list-check-suites-for-a-git-reference" }, "parameters": [ { @@ -376864,7 +377790,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -376873,7 +377799,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -378485,7 +379411,7 @@ "operationId": "repos/get-combined-status-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" }, "parameters": [ { @@ -378518,7 +379444,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -378527,7 +379453,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -379557,7 +380483,7 @@ "operationId": "repos/list-commit-statuses-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference" }, "parameters": [ { @@ -379590,7 +380516,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -379599,7 +380525,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -379880,14 +380806,14 @@ "/repos/{owner}/{repo}/community/profile": { "get": { "summary": "Get community profile metrics", - "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.", + "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.", "tags": [ "repos" ], "operationId": "repos/get-community-profile-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics" }, "parameters": [ { @@ -380198,14 +381124,14 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/compare-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits" }, "parameters": [ { @@ -380228,7 +381154,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -380237,7 +381163,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -382429,14 +383355,14 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", "tags": [ "repos" ], "operationId": "repos/get-content", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content" }, "parameters": [ { @@ -383277,14 +384203,14 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-cloud@latest/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "tags": [ "repos" ], "operationId": "repos/create-or-update-file-contents", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents" }, "parameters": [ { @@ -384035,14 +384961,14 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-cloud@latest/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], "operationId": "repos/delete-file", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file" }, "parameters": [ { @@ -384510,7 +385436,7 @@ "operationId": "repos/list-contributors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors" }, "parameters": [ { @@ -384542,7 +385468,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -384551,7 +385477,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -384765,7 +385691,7 @@ "operationId": "dependabot/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" }, "parameters": [ { @@ -384913,7 +385839,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -384922,7 +385848,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -384931,7 +385857,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -386258,7 +387184,7 @@ "operationId": "dependabot/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert" }, "parameters": [ { @@ -387373,14 +388299,14 @@ }, "patch": { "summary": "Update a Dependabot alert", - "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "dependabot" ], "operationId": "dependabot/update-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert" }, "parameters": [ { @@ -388671,7 +389597,7 @@ "operationId": "dependabot/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets" }, "parameters": [ { @@ -388694,7 +389620,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -388703,7 +389629,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -388805,7 +389731,7 @@ "operationId": "dependabot/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -388883,7 +389809,7 @@ "operationId": "dependabot/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret" }, "parameters": [ { @@ -388966,14 +389892,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -389013,7 +389939,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -389073,7 +389999,7 @@ "operationId": "dependabot/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -389127,7 +390053,7 @@ "operationId": "dependency-graph/diff-range", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" }, "parameters": [ { @@ -389398,7 +390324,7 @@ "operationId": "dependency-graph/export-sbom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -389760,7 +390686,7 @@ "operationId": "dependency-graph/fetch-sbom-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -389876,7 +390802,7 @@ "operationId": "dependency-graph/generate-sbom-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -389992,7 +390918,7 @@ "operationId": "dependency-graph/create-repository-snapshot", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" }, "parameters": [ { @@ -390351,7 +391277,7 @@ "operationId": "repos/list-deployments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments" }, "parameters": [ { @@ -390415,7 +391341,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -390424,7 +391350,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -391046,14 +391972,14 @@ }, "post": { "summary": "Create a deployment", - "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment" }, "parameters": [ { @@ -391098,7 +392024,7 @@ }, "required_contexts": { "type": "array", - "description": "The [status](https://docs.github.com/enterprise-cloud@latest//rest/commits/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.", + "description": "The [status](https://docs.github.com/enterprise-cloud@latest/rest/commits/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.", "items": { "type": "string" } @@ -391872,7 +392798,7 @@ "operationId": "repos/get-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment" }, "parameters": [ { @@ -392530,14 +393456,14 @@ }, "delete": { "summary": "Delete a deployment", - "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/delete-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment" }, "parameters": [ { @@ -392647,7 +393573,7 @@ "operationId": "repos/list-deployment-statuses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses" }, "parameters": [ { @@ -392679,7 +393605,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -392688,7 +393614,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -393335,7 +394261,7 @@ "operationId": "repos/create-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status" }, "parameters": [ { @@ -394111,7 +395037,7 @@ "operationId": "repos/get-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status" }, "parameters": [ { @@ -394778,7 +395704,7 @@ "operationId": "code-scanning/list-dismissal-requests-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -394858,7 +395784,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -394867,7 +395793,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -395251,7 +396177,7 @@ "operationId": "code-scanning/get-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -395615,7 +396541,7 @@ "operationId": "code-scanning/review-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -395852,7 +396778,7 @@ "operationId": "dependabot/list-dismissal-requests-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -395932,7 +396858,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -395941,7 +396867,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -396327,7 +397253,7 @@ "operationId": "dependabot/get-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#get-a-dismissal-request-for-a-dependabot-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#get-a-dismissal-request-for-a-dependabot-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -396682,7 +397608,7 @@ "operationId": "dependabot/create-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#create-a-dismissal-request-for-a-dependabot-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#create-a-dismissal-request-for-a-dependabot-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -397143,7 +398069,7 @@ "operationId": "dependabot/review-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#review-a-dismissal-request-for-a-dependabot-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#review-a-dismissal-request-for-a-dependabot-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -397398,7 +398324,7 @@ "operationId": "dependabot/cancel-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -397530,7 +398456,7 @@ "operationId": "secret-scanning/list-repo-dismissal-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -397612,7 +398538,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -397621,7 +398547,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -398001,7 +398927,7 @@ "operationId": "secret-scanning/get-dismissal-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -398361,7 +399287,7 @@ "operationId": "secret-scanning/review-dismissal-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -398611,14 +399537,14 @@ "/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 Enterprise Cloud 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/enterprise-cloud@latest//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 input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud 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/enterprise-cloud@latest/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 input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-dispatch-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event" }, "parameters": [ { @@ -398796,7 +399722,7 @@ "operationId": "repos/get-all-environments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments" }, "parameters": [ { @@ -398819,7 +399745,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -398828,7 +399754,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -399470,7 +400396,7 @@ "operationId": "repos/get-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment" }, "parameters": [ { @@ -400115,7 +401041,7 @@ "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment" }, "parameters": [ { @@ -400875,7 +401801,7 @@ "operationId": "repos/delete-an-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment" }, "parameters": [ { @@ -400929,7 +401855,7 @@ "operationId": "repos/list-deployment-branch-policies", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies" }, "parameters": [ { @@ -400961,7 +401887,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -400970,7 +401896,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -401069,7 +401995,7 @@ "operationId": "repos/create-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy" }, "parameters": [ { @@ -401239,7 +402165,7 @@ "operationId": "repos/get-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy" }, "parameters": [ { @@ -401343,7 +402269,7 @@ "operationId": "repos/update-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy" }, "parameters": [ { @@ -401475,7 +402401,7 @@ "operationId": "repos/delete-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy" }, "parameters": [ { @@ -401531,14 +402457,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { "get": { "summary": "Get all deployment protection rules for an environment", - "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-all-deployment-protection-rules", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" }, "parameters": [ { @@ -401725,14 +402651,14 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" }, "parameters": [ { @@ -401882,14 +402808,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { "get": { "summary": "List custom deployment rule integrations available for an environment", - "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/list-custom-deployment-rule-integrations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" }, "parameters": [ { @@ -401921,7 +402847,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -401930,7 +402856,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -402029,14 +402955,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { "get": { "summary": "Get a custom deployment protection rule", - "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-custom-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" }, "parameters": [ { @@ -402177,7 +403103,7 @@ "operationId": "repos/disable-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" }, "parameters": [ { @@ -402240,7 +403166,7 @@ "operationId": "actions/list-environment-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets" }, "parameters": [ { @@ -402272,7 +403198,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -402281,7 +403207,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -402383,7 +403309,7 @@ "operationId": "actions/get-environment-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key" }, "parameters": [ { @@ -402486,7 +403412,7 @@ "operationId": "actions/get-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret" }, "parameters": [ { @@ -402578,14 +403504,14 @@ }, "put": { "summary": "Create or update an environment secret", - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret" }, "parameters": [ { @@ -402634,7 +403560,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -402698,7 +403624,7 @@ "operationId": "actions/delete-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret" }, "parameters": [ { @@ -402761,7 +403687,7 @@ "operationId": "actions/list-environment-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables" }, "parameters": [ { @@ -402793,7 +403719,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -402802,7 +403728,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -402913,7 +403839,7 @@ "operationId": "actions/create-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable" }, "parameters": [ { @@ -403015,7 +403941,7 @@ "operationId": "actions/get-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable" }, "parameters": [ { @@ -403124,7 +404050,7 @@ "operationId": "actions/update-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable" }, "parameters": [ { @@ -403213,7 +404139,7 @@ "operationId": "actions/delete-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable" }, "parameters": [ { @@ -403276,7 +404202,7 @@ "operationId": "activity/list-repo-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events" }, "parameters": [ { @@ -403299,7 +404225,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -403308,7 +404234,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -413612,7 +414538,7 @@ "operationId": "repos/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks" }, "parameters": [ { @@ -413651,7 +414577,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -413660,7 +414586,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -414651,7 +415577,7 @@ "operationId": "repos/create-fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork" }, "parameters": [ { @@ -418702,7 +419628,7 @@ "operationId": "git/create-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob" }, "parameters": [ { @@ -419000,14 +419926,14 @@ "/repos/{owner}/{repo}/git/blobs/{file_sha}": { "get": { "summary": "Get a blob", - "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", "tags": [ "git" ], "operationId": "git/get-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob" }, "parameters": [ { @@ -419261,7 +420187,7 @@ "operationId": "git/create-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit" }, "parameters": [ { @@ -419740,7 +420666,7 @@ "operationId": "git/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object" }, "parameters": [ { @@ -420051,14 +420977,14 @@ "/repos/{owner}/{repo}/git/matching-refs/{ref}": { "get": { "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "tags": [ "git" ], "operationId": "git/list-matching-refs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references" }, "parameters": [ { @@ -420221,14 +421147,14 @@ "/repos/{owner}/{repo}/git/ref/{ref}": { "get": { "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "tags": [ "git" ], "operationId": "git/get-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference" }, "parameters": [ { @@ -420401,7 +421327,7 @@ "operationId": "git/create-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference" }, "parameters": [ { @@ -420646,7 +421572,7 @@ "operationId": "git/update-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference" }, "parameters": [ { @@ -420892,7 +421818,7 @@ "operationId": "git/delete-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference" }, "parameters": [ { @@ -420970,14 +421896,14 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/create-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object" }, "parameters": [ { @@ -421344,7 +422270,7 @@ "operationId": "git/get-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag" }, "parameters": [ { @@ -421584,14 +422510,14 @@ "/repos/{owner}/{repo}/git/trees": { "post": { "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", "tags": [ "git" ], "operationId": "git/create-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree" }, "parameters": [ { @@ -421961,7 +422887,7 @@ "operationId": "git/get-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree" }, "parameters": [ { @@ -422274,7 +423200,7 @@ "operationId": "repos/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks" }, "parameters": [ { @@ -422297,7 +423223,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -422306,7 +423232,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -422373,7 +423299,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -422546,7 +423472,7 @@ "operationId": "repos/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook" }, "parameters": [ { @@ -422597,7 +423523,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -422616,7 +423542,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -422709,7 +423635,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -422976,7 +423902,7 @@ "operationId": "repos/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook" }, "parameters": [ { @@ -423064,7 +423990,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -423226,7 +424152,7 @@ "operationId": "repos/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook" }, "parameters": [ { @@ -423282,7 +424208,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -423301,7 +424227,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -423400,7 +424326,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -423631,7 +424557,7 @@ "operationId": "repos/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook" }, "parameters": [ { @@ -423711,7 +424637,7 @@ "operationId": "repos/get-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -423765,7 +424691,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -423812,7 +424738,7 @@ "operationId": "repos/update-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -423864,7 +424790,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -423916,7 +424842,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { @@ -423965,7 +424891,7 @@ "operationId": "repos/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" }, "parameters": [ { @@ -423997,7 +424923,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -424309,7 +425235,7 @@ "operationId": "repos/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -424687,7 +425613,7 @@ "operationId": "repos/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -424883,14 +425809,14 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { "post": { "summary": "Ping a repository webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest/webhooks/#ping-event) to be sent to the hook.", "tags": [ "repos" ], "operationId": "repos/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook" }, "parameters": [ { @@ -424970,7 +425896,7 @@ "operationId": "repos/test-push-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook" }, "parameters": [ { @@ -425050,7 +425976,7 @@ "operationId": "repos/check-immutable-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository" }, "parameters": [ { @@ -425129,7 +426055,7 @@ "operationId": "repos/enable-immutable-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases" }, "parameters": [ { @@ -425198,7 +426124,7 @@ "operationId": "repos/disable-immutable-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases" }, "parameters": [ { @@ -425262,14 +426188,14 @@ "/repos/{owner}/{repo}/import": { "get": { "summary": "Get an import status", - "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", "tags": [ "migrations" ], "operationId": "migrations/get-import-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status" }, "parameters": [ { @@ -425520,7 +426446,7 @@ "operationId": "migrations/start-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import" }, "parameters": [ { @@ -425900,7 +426826,7 @@ "operationId": "migrations/update-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import" }, "parameters": [ { @@ -426217,7 +427143,7 @@ "operationId": "migrations/cancel-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import" }, "parameters": [ { @@ -426284,14 +427210,14 @@ "/repos/{owner}/{repo}/import/authors": { "get": { "summary": "Get commit authors", - "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ "migrations" ], "operationId": "migrations/get-commit-authors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors" }, "parameters": [ { @@ -426479,7 +427405,7 @@ "operationId": "migrations/map-commit-author", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author" }, "parameters": [ { @@ -426741,7 +427667,7 @@ "operationId": "migrations/get-large-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files" }, "parameters": [ { @@ -426864,14 +427790,14 @@ "/repos/{owner}/{repo}/import/lfs": { "patch": { "summary": "Update Git LFS preference", - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/enterprise-cloud@latest/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ "migrations" ], "operationId": "migrations/set-lfs-preference", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference" }, "parameters": [ { @@ -427190,14 +428116,14 @@ "/repos/{owner}/{repo}/installation": { "get": { "summary": "Get a repository installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-repo-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" }, "parameters": [ { @@ -428252,7 +429178,7 @@ "operationId": "interactions/get-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -428348,7 +429274,7 @@ "operationId": "interactions/set-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -428486,7 +429412,7 @@ "operationId": "interactions/remove-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -428534,7 +429460,7 @@ "operationId": "repos/list-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations" }, "parameters": [ { @@ -428557,7 +429483,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -428566,7 +429492,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -429809,7 +430735,7 @@ "operationId": "repos/update-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation" }, "parameters": [ { @@ -431092,7 +432018,7 @@ "operationId": "repos/delete-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation" }, "parameters": [ { @@ -431139,14 +432065,14 @@ "/repos/{owner}/{repo}/issues": { "get": { "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues" }, "parameters": [ { @@ -431277,7 +432203,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -431286,7 +432212,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -434565,14 +435491,14 @@ }, "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://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue" }, "parameters": [ { @@ -438075,14 +439001,14 @@ "/repos/{owner}/{repo}/issues/comments": { "get": { "summary": "List issue comments for a repository", - "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository" }, "parameters": [ { @@ -438142,7 +439068,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -438151,7 +439077,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -439024,14 +439950,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}": { "get": { "summary": "Get an issue comment", - "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment" }, "parameters": [ { @@ -439845,14 +440771,14 @@ }, "patch": { "summary": "Update an issue comment", - "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment" }, "parameters": [ { @@ -440742,7 +441668,7 @@ "operationId": "issues/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment" }, "parameters": [ { @@ -440790,14 +441716,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { "put": { "summary": "Pin an issue comment", - "description": "You can use the REST API to pin comments on issues.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to pin comments on issues.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/pin-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#pin-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment" }, "parameters": [ { @@ -441787,7 +442713,7 @@ "operationId": "issues/unpin-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#unpin-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment" }, "parameters": [ { @@ -441960,14 +442886,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for an issue comment", - "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment).", + "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment" }, "parameters": [ { @@ -442000,7 +442926,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", "in": "query", "required": false, "schema": { @@ -442019,7 +442945,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -442028,7 +442954,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -442290,14 +443216,14 @@ }, "post": { "summary": "Create reaction for an issue comment", - "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", + "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment" }, "parameters": [ { @@ -442338,7 +443264,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the issue comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the issue comment.", "enum": [ "+1", "-1", @@ -442855,14 +443781,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue comment reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction" }, "parameters": [ { @@ -442926,7 +443852,7 @@ "operationId": "issues/list-events-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository" }, "parameters": [ { @@ -442949,7 +443875,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -442958,7 +443884,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -447526,7 +448452,7 @@ "operationId": "issues/get-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event" }, "parameters": [ { @@ -452144,14 +453070,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}": { "get": { "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue" }, "parameters": [ { @@ -455620,14 +456546,14 @@ }, "patch": { "summary": "Update an issue", - "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -459152,7 +460078,7 @@ "operationId": "issues/add-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue" }, "parameters": [ { @@ -462356,7 +463282,7 @@ "operationId": "issues/remove-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue" }, "parameters": [ { @@ -465561,7 +466487,7 @@ "operationId": "issues/check-user-can-be-assigned-to-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" }, "parameters": [ { @@ -465642,14 +466568,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/comments": { "get": { "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments" }, "parameters": [ { @@ -465691,7 +466617,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -465700,7 +466626,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -466528,14 +467454,14 @@ }, "post": { "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -467506,14 +468432,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { "get": { "summary": "List dependencies an issue is blocked by", - "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-dependencies-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" }, "parameters": [ { @@ -467545,7 +468471,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -467554,7 +468480,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -470790,14 +471716,14 @@ }, "post": { "summary": "Add a dependency an issue is blocked by", - "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/add-blocked-by-dependency", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -474175,14 +475101,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { "delete": { "summary": "Remove dependency an issue is blocked by", - "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/remove-dependency-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -477552,14 +478478,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { "get": { "summary": "List dependencies an issue is blocking", - "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-dependencies-blocking", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" }, "parameters": [ { @@ -477591,7 +478517,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -477600,7 +478526,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -480845,7 +481771,7 @@ "operationId": "issues/list-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events" }, "parameters": [ { @@ -480877,7 +481803,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -480886,7 +481812,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -489762,7 +490688,7 @@ "operationId": "issues/list-issue-field-values-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#list-issue-field-values-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#list-issue-field-values-for-an-issue" }, "parameters": [ { @@ -489794,7 +490720,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -489803,7 +490729,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -490033,14 +490959,14 @@ }, "post": { "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], "operationId": "issues/add-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" }, "parameters": [ { @@ -490489,14 +491415,14 @@ }, "put": { "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], "operationId": "issues/set-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" }, "parameters": [ { @@ -490947,14 +491873,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { "delete": { "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], "operationId": "issues/delete-issue-field-value", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" }, "parameters": [ { @@ -491160,7 +492086,7 @@ "operationId": "issues/list-labels-on-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue" }, "parameters": [ { @@ -491192,7 +492118,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -491201,7 +492127,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -491400,7 +492326,7 @@ "operationId": "issues/add-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -491443,7 +492369,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue).\"", + "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue).\"", "items": { "type": "string" } @@ -491737,7 +492663,7 @@ "operationId": "issues/set-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue" }, "parameters": [ { @@ -491780,7 +492706,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue).\"", + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue).\"", "items": { "type": "string" } @@ -492099,7 +493025,7 @@ "operationId": "issues/remove-all-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue" }, "parameters": [ { @@ -492231,7 +493157,7 @@ "operationId": "issues/remove-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue" }, "parameters": [ { @@ -492439,14 +493365,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/lock": { "put": { "summary": "Lock an issue", - "description": "Users with push access can lock an issue or pull request's conversation.\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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Users with push access can lock an issue or pull request's conversation.\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 method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "issues" ], "operationId": "issues/lock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue" }, "parameters": [ { @@ -492676,7 +493602,7 @@ "operationId": "issues/unlock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue" }, "parameters": [ { @@ -492775,14 +493701,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/parent": { "get": { "summary": "Get parent issue", - "description": "You can use the REST API to get the parent issue of a sub-issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to get the parent issue of a sub-issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get-parent", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue" }, "parameters": [ { @@ -496030,14 +496956,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { "get": { "summary": "List reactions for an issue", - "description": "List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue).", + "description": "List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue" }, "parameters": [ { @@ -496069,7 +496995,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", "in": "query", "required": false, "schema": { @@ -496088,7 +497014,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -496097,7 +497023,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -496385,14 +497311,14 @@ }, "post": { "summary": "Create reaction for an issue", - "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", + "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue" }, "parameters": [ { @@ -496432,7 +497358,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the issue.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the issue.", "enum": [ "+1", "-1", @@ -496949,14 +497875,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction" }, "parameters": [ { @@ -497012,14 +497938,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { "delete": { "summary": "Remove sub-issue", - "description": "You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/remove-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue" }, "parameters": [ { @@ -500310,14 +501236,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { "get": { "summary": "List sub-issues", - "description": "You can use the REST API to list the sub-issues on an issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list the sub-issues on an issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-sub-issues", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues" }, "parameters": [ { @@ -500349,7 +501275,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -500358,7 +501284,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -503568,14 +504494,14 @@ }, "post": { "summary": "Add sub-issue", - "description": "You can use the REST API to add sub-issues to issues.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to add sub-issues to issues.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/add-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue" }, "parameters": [ { @@ -506937,7 +507863,7 @@ "operationId": "issues/reprioritize-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue" }, "parameters": [ { @@ -510253,7 +511179,7 @@ "operationId": "issues/list-events-for-timeline", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue" }, "parameters": [ { @@ -510285,7 +511211,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -510294,7 +511220,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -524604,7 +525530,7 @@ "operationId": "repos/list-deploy-keys", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys" }, "parameters": [ { @@ -524627,7 +525553,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -524636,7 +525562,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -524747,7 +525673,7 @@ "operationId": "repos/create-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key" }, "parameters": [ { @@ -524786,7 +525712,7 @@ }, "read_only": { "type": "boolean", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/).\"" + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest/articles/permission-levels-for-a-user-account-repository/).\"" } }, "required": [ @@ -524974,7 +525900,7 @@ "operationId": "repos/get-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key" }, "parameters": [ { @@ -525121,7 +526047,7 @@ "operationId": "repos/delete-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key" }, "parameters": [ { @@ -525175,7 +526101,7 @@ "operationId": "issues/list-labels-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository" }, "parameters": [ { @@ -525198,7 +526124,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -525207,7 +526133,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -525354,7 +526280,7 @@ "operationId": "issues/create-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label" }, "parameters": [ { @@ -525608,7 +526534,7 @@ "operationId": "issues/get-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label" }, "parameters": [ { @@ -525755,7 +526681,7 @@ "operationId": "issues/update-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label" }, "parameters": [ { @@ -525909,7 +526835,7 @@ "operationId": "issues/delete-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label" }, "parameters": [ { @@ -525962,7 +526888,7 @@ "operationId": "repos/list-languages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages" }, "parameters": [ { @@ -526027,7 +526953,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository" }, "parameters": [ { @@ -526085,7 +527011,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository" }, "parameters": [ { @@ -526123,14 +527049,14 @@ "/repos/{owner}/{repo}/license": { "get": { "summary": "Get the license for a repository", - "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "licenses" ], "operationId": "licenses/get-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository" }, "parameters": [ { @@ -526372,7 +527298,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -526483,7 +527409,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -527321,7 +528247,7 @@ "operationId": "issues/list-milestones", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones" }, "parameters": [ { @@ -527387,7 +528313,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -527396,7 +528322,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -527737,7 +528663,7 @@ "operationId": "issues/create-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone" }, "parameters": [ { @@ -528205,7 +529131,7 @@ "operationId": "issues/get-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone" }, "parameters": [ { @@ -528556,7 +529482,7 @@ "operationId": "issues/update-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone" }, "parameters": [ { @@ -528925,7 +529851,7 @@ "operationId": "issues/delete-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone" }, "parameters": [ { @@ -529005,7 +529931,7 @@ "operationId": "issues/list-labels-for-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-issues-in-a-milestone" }, "parameters": [ { @@ -529037,7 +529963,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -529046,7 +529972,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -529169,7 +530095,7 @@ "operationId": "activity/list-repo-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -529232,7 +530158,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -529241,7 +530167,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -530199,14 +531125,14 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-repo-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read" }, "parameters": [ { @@ -530300,7 +531226,7 @@ "operationId": "repos/get-pages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site" }, "parameters": [ { @@ -530550,7 +531476,7 @@ "operationId": "repos/create-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site" }, "parameters": [ { @@ -530935,7 +531861,7 @@ "operationId": "repos/update-information-about-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#update-information-about-a-apiname-pages-site" }, "parameters": [ { @@ -530966,7 +531892,7 @@ "properties": { "cname": { "type": "string", - "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://docs.github.com/enterprise-cloud@latest//pages/configuring-a-custom-domain-for-your-github-pages-site).\"", + "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://docs.github.com/enterprise-cloud@latest/pages/configuring-a-custom-domain-for-your-github-pages-site).\"", "nullable": true }, "https_enforced": { @@ -531239,7 +532165,7 @@ "operationId": "repos/delete-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site" }, "parameters": [ { @@ -531405,7 +532331,7 @@ "operationId": "repos/list-pages-builds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds" }, "parameters": [ { @@ -531428,7 +532354,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -531437,7 +532363,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -531693,7 +532619,7 @@ "operationId": "repos/request-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build" }, "parameters": [ { @@ -531770,7 +532696,7 @@ "operationId": "repos/get-latest-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build" }, "parameters": [ { @@ -532029,7 +532955,7 @@ "operationId": "repos/get-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build" }, "parameters": [ { @@ -532296,7 +533222,7 @@ "operationId": "repos/create-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment" }, "parameters": [ { @@ -532599,7 +533525,7 @@ "operationId": "repos/get-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-the-status-of-a-github-pages-deployment" }, "parameters": [ { @@ -532720,7 +533646,7 @@ "operationId": "repos/cancel-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment" }, "parameters": [ { @@ -532807,7 +533733,7 @@ "operationId": "repos/get-pages-health-check", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-dns-health-check-for-github-pages" }, "parameters": [ { @@ -533188,14 +534114,14 @@ "/repos/{owner}/{repo}/private-vulnerability-reporting": { "get": { "summary": "Check if private vulnerability reporting is enabled for a repository", - "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", "tags": [ "repos" ], "operationId": "repos/check-private-vulnerability-reporting", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository" }, "parameters": [ { @@ -533314,14 +534240,14 @@ }, "put": { "summary": "Enable private vulnerability reporting for a repository", - "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", + "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", "tags": [ "repos" ], "operationId": "repos/enable-private-vulnerability-reporting", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository" }, "parameters": [ { @@ -533417,14 +534343,14 @@ }, "delete": { "summary": "Disable private vulnerability reporting for a repository", - "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", "tags": [ "repos" ], "operationId": "repos/disable-private-vulnerability-reporting", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" }, "parameters": [ { @@ -533529,7 +534455,7 @@ "operationId": "repos/custom-properties-for-repos-get-repository-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository" }, "parameters": [ { @@ -533679,7 +534605,7 @@ "operationId": "repos/custom-properties-for-repos-create-or-update-repository-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" }, "parameters": [ { @@ -533907,14 +534833,14 @@ "/repos/{owner}/{repo}/pulls": { "get": { "summary": "List pull requests", - "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests" }, "parameters": [ { @@ -533999,7 +534925,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -534008,7 +534934,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -537853,14 +538779,14 @@ }, "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://docs.github.com/enterprise-cloud@latest//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\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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://docs.github.com/enterprise-cloud@latest/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\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request" }, "parameters": [ { @@ -537913,11 +538839,11 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." }, "draft": { "type": "boolean", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest//articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." }, "issue": { "type": "integer", @@ -541898,14 +542824,14 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository" }, "parameters": [ { @@ -541964,7 +542890,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -541973,7 +542899,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -542480,14 +543406,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -543029,14 +543955,14 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#update-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -543585,7 +544511,7 @@ "operationId": "pulls/delete-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -543659,14 +544585,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/list-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" }, "parameters": [ { @@ -543699,7 +544625,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", "required": false, "schema": { @@ -543718,7 +544644,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -543727,7 +544653,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -543989,14 +544915,14 @@ }, "post": { "summary": "Create reaction for a pull request review comment", - "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", + "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" }, "parameters": [ { @@ -544037,7 +544963,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the pull request review comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", "enum": [ "+1", "-1", @@ -544554,14 +545480,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a pull request comment reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-pull-request-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction" }, "parameters": [ { @@ -544618,14 +545544,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}": { "get": { "summary": "Get 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://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "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://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "tags": [ "pulls" ], "operationId": "pulls/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request" }, "parameters": [ { @@ -544658,7 +545584,7 @@ ], "responses": { "200": { - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", + "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", "content": { "application/json": { "schema": { @@ -548606,14 +549532,14 @@ }, "patch": { "summary": "Update 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://docs.github.com/enterprise-cloud@latest//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\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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://docs.github.com/enterprise-cloud@latest/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\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request" }, "parameters": [ { @@ -548673,7 +549599,7 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." } } }, @@ -552642,7 +553568,7 @@ "operationId": "pulls/archive", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request" }, "parameters": [ { @@ -552815,7 +553741,7 @@ "operationId": "pulls/unarchive", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request" }, "parameters": [ { @@ -552990,7 +553916,7 @@ "operationId": "codespaces/create-with-pr-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request" }, "parameters": [ { @@ -556144,14 +557070,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-on-a-pull-request" }, "parameters": [ { @@ -556220,7 +557146,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -556229,7 +557155,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -556734,14 +557660,14 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -556801,7 +557727,7 @@ }, "side": { "type": "string", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-cloud@latest//articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-cloud@latest/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -556813,11 +557739,11 @@ }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -557451,14 +558377,14 @@ "/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://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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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/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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-reply-for-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-reply-for-a-review-comment" }, "parameters": [ { @@ -558046,14 +558972,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { "get": { "summary": "List commits on a pull request", - "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request" }, "parameters": [ { @@ -558085,7 +559011,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -558094,7 +559020,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -558766,14 +559692,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/files": { "get": { "summary": "List pull requests files", - "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files" }, "parameters": [ { @@ -558805,7 +559731,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -558814,7 +559740,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -559069,7 +559995,7 @@ "operationId": "pulls/check-if-merged", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" }, "parameters": [ { @@ -559117,14 +560043,14 @@ }, "put": { "summary": "Merge a pull request", - "description": "Merges a pull request into the base branch.\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Merges a pull request into the base branch.\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], "operationId": "pulls/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request" }, "parameters": [ { @@ -559419,14 +560345,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "Get all requested reviewers for a pull request", - "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": [ "pulls" ], "operationId": "pulls/list-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" }, "parameters": [ { @@ -559879,14 +560805,14 @@ }, "post": { "summary": "Request reviewers for a pull request", - "description": "Requests reviews for a pull request from a given set of users and/or teams.\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Requests reviews for a pull request from a given set of users and/or teams.\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], "operationId": "pulls/request-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#request-reviewers-for-a-pull-request" }, "parameters": [ { @@ -563798,7 +564724,7 @@ "operationId": "pulls/remove-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" }, "parameters": [ { @@ -567695,14 +568621,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { "get": { "summary": "List reviews for a pull request", - "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-reviews", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request" }, "parameters": [ { @@ -567734,7 +568660,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -567743,7 +568669,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -568061,14 +568987,14 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "Creates a review on a specified pull request.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review on a specified pull request.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request" }, "parameters": [ { @@ -568116,7 +569042,7 @@ }, "event": { "type": "string", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -568541,14 +569467,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { "get": { "summary": "Get a review for a pull request", - "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#get-a-review-for-a-pull-request" }, "parameters": [ { @@ -568911,14 +569837,14 @@ }, "put": { "summary": "Update a review for a pull request", - "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#update-a-review-for-a-pull-request" }, "parameters": [ { @@ -569311,14 +570237,14 @@ }, "delete": { "summary": "Delete a pending review for a pull request", - "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/delete-pending-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" }, "parameters": [ { @@ -569713,14 +570639,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { "get": { "summary": "List comments for a pull request review", - "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-comments-for-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-comments-for-a-pull-request-review" }, "parameters": [ { @@ -569761,7 +570687,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -569770,7 +570696,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -570285,14 +571211,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { "put": { "summary": "Dismiss a review for a pull request", - "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/dismiss-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" }, "parameters": [ { @@ -570721,14 +571647,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { "post": { "summary": "Submit a review for a pull request", - "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/submit-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request" }, "parameters": [ { @@ -571192,7 +572118,7 @@ "operationId": "pulls/update-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch" }, "parameters": [ { @@ -571233,7 +572159,7 @@ "properties": { "expected_head_sha": { "type": "string", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." } } }, @@ -571381,14 +572307,14 @@ "/repos/{owner}/{repo}/readme": { "get": { "summary": "Get a repository README", - "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme" }, "parameters": [ { @@ -571655,14 +572581,14 @@ "/repos/{owner}/{repo}/readme/{dir}": { "get": { "summary": "Get a repository README for a directory", - "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme-in-directory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme-for-a-directory" }, "parameters": [ { @@ -571936,14 +572862,14 @@ "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", "tags": [ "repos" ], "operationId": "repos/list-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases" }, "parameters": [ { @@ -571966,7 +572892,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -571975,7 +572901,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -572614,14 +573540,14 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Users with push access to the repository can create a release.\n\nThis 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. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "repos" ], "operationId": "repos/create-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release" }, "parameters": [ { @@ -572678,7 +573604,7 @@ }, "discussion_category_name": { "type": "string", - "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" + "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" }, "generate_release_notes": { "type": "boolean", @@ -573415,14 +574341,14 @@ "/repos/{owner}/{repo}/releases/assets/{asset_id}": { "get": { "summary": "Get a release asset", - "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", "tags": [ "repos" ], "operationId": "repos/get-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset" }, "parameters": [ { @@ -573746,7 +574672,7 @@ "operationId": "repos/update-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset" }, "parameters": [ { @@ -574073,7 +574999,7 @@ "operationId": "repos/delete-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset" }, "parameters": [ { @@ -574146,14 +575072,14 @@ "/repos/{owner}/{repo}/releases/generate-notes": { "post": { "summary": "Generate release notes content for a release", - "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", + "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", "tags": [ "repos" ], "operationId": "repos/generate-release-notes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#generate-release-notes-content-for-a-release" }, "parameters": [ { @@ -574297,7 +575223,7 @@ "operationId": "repos/get-latest-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release" }, "parameters": [ { @@ -574947,7 +575873,7 @@ "operationId": "repos/get-release-by-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name" }, "parameters": [ { @@ -575600,14 +576526,14 @@ "/repos/{owner}/{repo}/releases/{release_id}": { "get": { "summary": "Get a release", - "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "tags": [ "repos" ], "operationId": "repos/get-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release" }, "parameters": [ { @@ -575640,7 +576566,7 @@ ], "responses": { "200": { - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "content": { "application/json": { "schema": { @@ -576241,7 +577167,7 @@ "operationId": "repos/update-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release" }, "parameters": [ { @@ -576315,7 +577241,7 @@ }, "discussion_category_name": { "type": "string", - "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" + "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" } } }, @@ -576960,7 +577886,7 @@ "operationId": "repos/delete-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release" }, "parameters": [ { @@ -577040,7 +577966,7 @@ "operationId": "repos/list-release-assets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets" }, "parameters": [ { @@ -577072,7 +577998,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -577081,7 +578007,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -577359,14 +578285,14 @@ }, "post": { "summary": "Upload a release asset", - "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", + "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", "tags": [ "repos" ], "operationId": "repos/upload-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#upload-a-release-asset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#upload-a-release-asset" }, "servers": [ { @@ -577697,14 +578623,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions": { "get": { "summary": "List reactions for a release", - "description": "List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release).", + "description": "List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/list-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release" }, "parameters": [ { @@ -577736,7 +578662,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", "in": "query", "required": false, "schema": { @@ -577753,7 +578679,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -577762,7 +578688,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -578024,14 +578950,14 @@ }, "post": { "summary": "Create reaction for a release", - "description": "Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", + "description": "Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", "tags": [ "reactions" ], "operationId": "reactions/create-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release" }, "parameters": [ { @@ -578071,7 +578997,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the release.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the release.", "enum": [ "+1", "laugh", @@ -578586,14 +579512,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a release reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction" }, "parameters": [ { @@ -578656,7 +579582,7 @@ "operationId": "repos/get-branch-rules", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch" }, "parameters": [ { @@ -578679,7 +579605,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -578689,7 +579615,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -578698,7 +579624,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -580065,7 +580991,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -580075,7 +581001,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -580233,7 +581159,7 @@ "operationId": "repos/get-repo-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-all-repository-rulesets" }, "x-github": { "githubCloudOnly": false, @@ -580262,7 +581188,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -580271,7 +581197,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -581542,7 +582468,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -581552,7 +582478,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -581731,7 +582657,7 @@ "operationId": "repos/create-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#create-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -582690,7 +583616,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -582700,7 +583626,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -584046,7 +584972,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -584056,7 +584982,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -584306,14 +585232,14 @@ "/repos/{owner}/{repo}/rulesets/rule-suites": { "get": { "summary": "List repository rule suites", - "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", "tags": [ "repos" ], "operationId": "repos/get-repo-rule-suites", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites" }, "parameters": [ { @@ -584384,7 +585310,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -584393,7 +585319,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -584569,14 +585495,14 @@ "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { "get": { "summary": "Get a repository rule suite", - "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", "tags": [ "repos" ], "operationId": "repos/get-repo-rule-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite" }, "parameters": [ { @@ -584599,7 +585525,7 @@ }, { "name": "rule_suite_id", - "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", "in": "path", "required": true, "schema": { @@ -584853,7 +585779,7 @@ "operationId": "repos/get-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -586141,7 +587067,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -586151,7 +587077,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -586337,7 +587263,7 @@ "operationId": "repos/update-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#update-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#update-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -587304,7 +588230,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -587314,7 +588240,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -588656,7 +589582,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -588666,7 +589592,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -588921,7 +589847,7 @@ "operationId": "repos/delete-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#delete-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -589027,7 +589953,7 @@ "operationId": "repos/get-repo-ruleset-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history" }, "parameters": [ { @@ -589050,7 +589976,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -589059,7 +589985,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -589220,7 +590146,7 @@ "operationId": "repos/get-repo-ruleset-version", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version" }, "parameters": [ { @@ -589434,7 +590360,7 @@ "operationId": "secret-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -589471,7 +590397,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -589480,7 +590406,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -589566,7 +590492,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -589575,7 +590501,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -589584,7 +590510,7 @@ }, { "name": "before", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -589593,7 +590519,7 @@ }, { "name": "after", - "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.", + "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.", "in": "query", "required": false, "schema": { @@ -589846,7 +590772,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -590936,7 +591862,7 @@ "operationId": "secret-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" }, "parameters": [ { @@ -591183,7 +592109,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -592181,7 +593107,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" }, "parameters": [ { @@ -592249,6 +593175,15 @@ "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", "type": "string", "nullable": true + }, + "validity": { + "type": "string", + "nullable": true, + "enum": [ + "active", + "inactive" + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -592496,7 +593431,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -593496,7 +594431,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "description": "Service unavailable", @@ -593538,7 +594473,7 @@ "operationId": "secret-scanning/list-locations-for-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" }, "parameters": [ { @@ -593572,7 +594507,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -593581,7 +594516,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -594114,7 +595049,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass" }, "parameters": [ { @@ -594256,14 +595191,14 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], "operationId": "secret-scanning/get-scan-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository" }, "parameters": [ { @@ -594570,7 +595505,7 @@ "operationId": "security-advisories/list-repository-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories" }, "parameters": [ { @@ -594622,7 +595557,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -594631,7 +595566,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -594640,7 +595575,7 @@ }, { "name": "per_page", - "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -596792,7 +597727,7 @@ "operationId": "security-advisories/create-repository-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-repository-security-advisory" }, "parameters": [ { @@ -599024,14 +599959,14 @@ "/repos/{owner}/{repo}/security-advisories/reports": { "post": { "summary": "Privately report a security vulnerability", - "description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.", + "description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.", "tags": [ "security-advisories" ], "operationId": "security-advisories/create-private-vulnerability-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability" }, "parameters": [ { @@ -601067,7 +602002,7 @@ "operationId": "security-advisories/get-repository-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#get-a-repository-security-advisory" }, "parameters": [ { @@ -602998,7 +603933,7 @@ "operationId": "security-advisories/update-repository-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#update-a-repository-security-advisory" }, "parameters": [ { @@ -605493,14 +606428,14 @@ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { "post": { "summary": "Request a CVE for a repository security advisory", - "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nIn order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", + "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nIn order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "tags": [ "security-advisories" ], "operationId": "security-advisories/create-repository-advisory-cve-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory" }, "parameters": [ { @@ -605747,7 +606682,7 @@ "operationId": "security-advisories/create-fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-temporary-private-fork" }, "parameters": [ { @@ -609766,14 +610701,14 @@ "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", - "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-stargazers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers" }, "parameters": [ { @@ -609796,7 +610731,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -609805,7 +610740,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -610246,7 +611181,7 @@ "operationId": "repos/get-code-frequency-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity" }, "parameters": [ { @@ -610338,7 +611273,7 @@ "operationId": "repos/get-commit-activity-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-last-year-of-commit-activity" }, "parameters": [ { @@ -610462,7 +611397,7 @@ "operationId": "repos/get-contributors-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity" }, "parameters": [ { @@ -610738,7 +611673,7 @@ "operationId": "repos/get-participation-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count" }, "parameters": [ { @@ -610949,7 +611884,7 @@ "operationId": "repos/get-punch-card-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" }, "parameters": [ { @@ -611033,7 +611968,7 @@ "operationId": "repos/create-commit-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status" }, "parameters": [ { @@ -611363,7 +612298,7 @@ "operationId": "activity/list-watchers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers" }, "parameters": [ { @@ -611386,7 +612321,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -611395,7 +612330,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -611591,7 +612526,7 @@ "operationId": "activity/get-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription" }, "parameters": [ { @@ -611715,14 +612650,14 @@ }, "put": { "summary": "Set a repository subscription", - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription) completely.", + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription) completely.", "tags": [ "activity" ], "operationId": "activity/set-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription" }, "parameters": [ { @@ -611845,14 +612780,14 @@ }, "delete": { "summary": "Delete a repository subscription", - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription).", + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription).", "tags": [ "activity" ], "operationId": "activity/delete-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription" }, "parameters": [ { @@ -611897,7 +612832,7 @@ "operationId": "repos/list-tags", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags" }, "parameters": [ { @@ -611920,7 +612855,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -611929,7 +612864,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -612037,7 +612972,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar" }, "operationId": "repos/download-tarball-archive", "parameters": [ @@ -612100,7 +613035,7 @@ "operationId": "repos/list-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams" }, "parameters": [ { @@ -612123,7 +613058,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -612132,7 +613067,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -612435,7 +613370,7 @@ "operationId": "repos/get-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics" }, "parameters": [ { @@ -612458,7 +613393,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -612467,7 +613402,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -612554,7 +613489,7 @@ "operationId": "repos/replace-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics" }, "parameters": [ { @@ -612721,7 +613656,7 @@ "operationId": "repos/get-clones", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones" }, "parameters": [ { @@ -612939,7 +613874,7 @@ "operationId": "repos/get-top-paths", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths" }, "parameters": [ { @@ -613112,7 +614047,7 @@ "operationId": "repos/get-top-referrers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources" }, "parameters": [ { @@ -613240,7 +614175,7 @@ "operationId": "repos/get-views", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views" }, "parameters": [ { @@ -613451,14 +614386,14 @@ "/repos/{owner}/{repo}/transfer": { "post": { "summary": "Transfer a repository", - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/).", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-cloud@latest/articles/about-repository-transfers/).", "tags": [ "repos" ], "operationId": "repos/transfer", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository" }, "parameters": [ { @@ -614539,14 +615474,14 @@ "/repos/{owner}/{repo}/vulnerability-alerts": { "get": { "summary": "Check if vulnerability alerts are enabled for a repository", - "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/check-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" }, "parameters": [ { @@ -614585,14 +615520,14 @@ }, "put": { "summary": "Enable vulnerability alerts", - "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/enable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts" }, "parameters": [ { @@ -614628,14 +615563,14 @@ }, "delete": { "summary": "Disable vulnerability alerts", - "description": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/disable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts" }, "parameters": [ { @@ -614679,7 +615614,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip" }, "operationId": "repos/download-zipball-archive", "parameters": [ @@ -614735,14 +615670,14 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "tags": [ "repos" ], "operationId": "repos/create-using-template", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-using-a-template" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-using-a-template" }, "parameters": [ { @@ -618627,14 +619562,14 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", "tags": [ "repos" ], "operationId": "repos/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-public-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-public-repositories" }, "parameters": [ { @@ -619600,7 +620535,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" }, "parameters": [ { @@ -620134,7 +621069,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, "parameters": [ { @@ -620652,7 +621587,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" }, "parameters": [ { @@ -621127,7 +622062,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" }, "parameters": [ { @@ -621718,7 +622653,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" }, "parameters": [ { @@ -622308,7 +623243,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" }, "parameters": [ { @@ -622605,7 +623540,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" }, "parameters": [ { @@ -623201,7 +624136,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, "parameters": [ { @@ -623965,7 +624900,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" }, "parameters": [ { @@ -624507,7 +625442,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" }, "parameters": [ { @@ -625236,7 +626171,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" }, "parameters": [ { @@ -625964,7 +626899,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" }, "parameters": [ { @@ -626260,7 +627195,7 @@ "operationId": "scim/list-provisioned-identities", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#list-scim-provisioned-identities" }, "parameters": [ { @@ -626972,14 +627907,14 @@ }, "post": { "summary": "Provision and invite a SCIM user", - "description": "Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see \"[Reinstating a former member of your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization).\"", + "description": "Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see \"[Reinstating a former member of your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization).\"", "tags": [ "scim" ], "operationId": "scim/provision-and-invite-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#provision-and-invite-a-scim-user" }, "parameters": [ { @@ -627754,7 +628689,7 @@ "operationId": "scim/get-provisioning-information-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user" }, "parameters": [ { @@ -628189,14 +629124,14 @@ }, "put": { "summary": "Update a provisioned organization membership", - "description": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n> [!WARNING]\n> Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`.", + "description": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n> [!WARNING]\n> Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`.", "tags": [ "scim" ], "operationId": "scim/set-information-for-provisioned-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership" }, "parameters": [ { @@ -628756,7 +629691,7 @@ "operationId": "scim/update-attribute-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user" }, "parameters": [ { @@ -629410,7 +630345,7 @@ "operationId": "scim/delete-user-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization" }, "parameters": [ { @@ -629597,19 +630532,19 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], "operationId": "search/code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-code" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -629619,7 +630554,7 @@ { "name": "sort", "deprecated": true, - "description": "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -629646,7 +630581,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -629655,7 +630590,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -630775,19 +631710,19 @@ "/search/commits": { "get": { "summary": "Search commits", - "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", + "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", "tags": [ "search" ], "operationId": "search/commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-commits" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -630796,7 +631731,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -630823,7 +631758,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -630832,7 +631767,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -632135,19 +633070,19 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "tags": [ "search" ], "operationId": "search/issues-and-pull-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-issues-and-pull-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-issues-and-pull-requests" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -632156,7 +633091,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -632192,7 +633127,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -632201,7 +633136,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -635400,14 +636335,14 @@ "/search/labels": { "get": { "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-labels" }, "parameters": [ { @@ -635421,7 +636356,7 @@ }, { "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query).", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -635430,7 +636365,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -635457,7 +636392,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -635466,7 +636401,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -635749,19 +636684,19 @@ "/search/repositories": { "get": { "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], "operationId": "search/repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-repositories" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -635770,7 +636705,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -635799,7 +636734,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -635808,7 +636743,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -636673,19 +637608,19 @@ "/search/topics": { "get": { "summary": "Search topics", - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-cloud@latest/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-topics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-topics" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query).", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -636694,7 +637629,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -636703,7 +637638,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -637001,19 +637936,19 @@ "/search/users": { "get": { "summary": "Search users", - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search).\"", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest/graphql/reference/queries#search).\"", "tags": [ "search" ], "operationId": "search/users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-users" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-users" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -637022,7 +637957,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -637050,7 +637985,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -637059,7 +637994,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -637421,14 +638356,14 @@ "/teams/{team_id}": { "get": { "summary": "Get a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -638043,14 +638978,14 @@ }, "patch": { "summary": "Update a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], "operationId": "teams/update-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -639386,14 +640321,14 @@ }, "delete": { "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], "operationId": "teams/delete-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy" }, "parameters": [ { @@ -639520,14 +640455,14 @@ "/teams/{team_id}/invitations": { "get": { "summary": "List pending team invitations (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.", "tags": [ "teams" ], "operationId": "teams/list-pending-invitations-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy" }, "parameters": [ { @@ -639541,7 +640476,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -639550,7 +640485,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -639814,14 +640749,14 @@ "/teams/{team_id}/members": { "get": { "summary": "List team members (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "tags": [ "teams" ], "operationId": "teams/list-members-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy" }, "parameters": [ { @@ -639850,7 +640785,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -639859,7 +640794,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -640077,14 +641012,14 @@ "/teams/{team_id}/members/{username}": { "get": { "summary": "Get team member (Legacy)", - "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ "teams" ], "operationId": "teams/get-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy" }, "parameters": [ { @@ -640126,14 +641061,14 @@ }, "put": { "summary": "Add team member (Legacy)", - "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy" }, "parameters": [ { @@ -640204,14 +641139,14 @@ }, "delete": { "summary": "Remove team member (Legacy)", - "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy" }, "parameters": [ { @@ -640255,14 +641190,14 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -640375,14 +641310,14 @@ }, "put": { "summary": "Add or update team membership for a user (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -640530,14 +641465,14 @@ }, "delete": { "summary": "Remove team membership for a user (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -640581,14 +641516,14 @@ "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -640602,7 +641537,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -640611,7 +641546,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -641573,14 +642508,14 @@ "/teams/{team_id}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository-legacy" }, "parameters": [ { @@ -642435,14 +643370,14 @@ }, "put": { "summary": "Add or update team repository permissions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the 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 method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions-legacy" }, "parameters": [ { @@ -642614,14 +643549,14 @@ }, "delete": { "summary": "Remove a repository from a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "tags": [ "teams" ], "operationId": "teams/remove-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team-legacy" }, "parameters": [ { @@ -642671,14 +643606,14 @@ "/teams/{team_id}/team-sync/group-mappings": { "get": { "summary": "List IdP groups for a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nList IdP groups connected to a team on GitHub Enterprise Cloud.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nList IdP groups connected to a team on GitHub Enterprise Cloud.", "tags": [ "teams" ], "operationId": "teams/list-idp-groups-for-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team-legacy" }, "parameters": [ { @@ -642841,14 +643776,14 @@ }, "patch": { "summary": "Create or update IdP group connections (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.", "tags": [ "teams" ], "operationId": "teams/create-or-update-idp-group-connections-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections-legacy" }, "parameters": [ { @@ -643122,14 +644057,14 @@ "/teams/{team_id}/teams": { "get": { "summary": "List child teams (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-child-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy" }, "parameters": [ { @@ -643143,7 +644078,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -643152,7 +644087,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -643566,7 +644501,7 @@ "operationId": "users/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-the-authenticated-user" }, "parameters": [], "responses": { @@ -644205,7 +645140,7 @@ "operationId": "users/update-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#update-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#update-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -644750,12 +645685,12 @@ "operationId": "users/list-blocked-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#list-users-blocked-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#list-users-blocked-by-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -644764,7 +645699,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -645033,7 +645968,7 @@ "operationId": "users/check-blocked", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user" }, "parameters": [ { @@ -645148,7 +646083,7 @@ "operationId": "users/block", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#block-a-user" }, "parameters": [ { @@ -645332,7 +646267,7 @@ "operationId": "users/unblock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#unblock-a-user" }, "parameters": [ { @@ -645449,12 +646384,12 @@ "operationId": "codespaces/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -645463,7 +646398,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -647378,7 +648313,7 @@ "operationId": "codespaces/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user" }, "requestBody": { "required": true, @@ -650581,12 +651516,12 @@ "operationId": "codespaces/list-secrets-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-secrets-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-secrets-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -650595,7 +651530,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -650718,7 +651653,7 @@ "operationId": "codespaces/get-public-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-public-key-for-the-authenticated-user" }, "responses": { "200": { @@ -650776,7 +651711,7 @@ "operationId": "codespaces/get-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user" }, "parameters": [ { @@ -650862,14 +651797,14 @@ }, "put": { "summary": "Create or update a secret for the authenticated user", - "description": "Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "description": "Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/create-or-update-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user" }, "parameters": [ { @@ -650891,7 +651826,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -650900,7 +651835,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", + "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", "items": { "anyOf": [ { @@ -651067,7 +652002,7 @@ "operationId": "codespaces/delete-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user" }, "parameters": [ { @@ -651103,7 +652038,7 @@ "operationId": "codespaces/list-repositories-for-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret" }, "parameters": [ { @@ -652277,7 +653212,7 @@ "operationId": "codespaces/set-repositories-for-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret" }, "parameters": [ { @@ -652299,7 +653234,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", + "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", "items": { "type": "integer" } @@ -652449,7 +653384,7 @@ "operationId": "codespaces/add-repository-for-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret" }, "parameters": [ { @@ -652595,7 +653530,7 @@ "operationId": "codespaces/remove-repository-for-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret" }, "parameters": [ { @@ -652743,7 +653678,7 @@ "operationId": "codespaces/get-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -654353,7 +655288,7 @@ "operationId": "codespaces/update-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -655968,7 +656903,7 @@ "operationId": "codespaces/delete-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -656123,7 +657058,7 @@ "operationId": "codespaces/export-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -656396,7 +657331,7 @@ "operationId": "codespaces/get-export-details-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-details-about-a-codespace-export" }, "parameters": [ { @@ -656531,7 +657466,7 @@ "operationId": "codespaces/codespace-machines-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-machine-types-for-a-codespace" }, "parameters": [ { @@ -656775,7 +657710,7 @@ "operationId": "codespaces/publish-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace" }, "parameters": [ { @@ -661395,7 +662330,7 @@ "operationId": "codespaces/start-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -663119,7 +664054,7 @@ "operationId": "codespaces/stop-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -664728,7 +665663,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" }, "responses": { "200": { @@ -665790,7 +666725,7 @@ "operationId": "users/set-primary-email-visibility-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -666047,12 +666982,12 @@ "operationId": "users/list-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#list-email-addresses-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -666061,7 +666996,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -666229,7 +667164,7 @@ "operationId": "users/add-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#add-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#add-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -666523,7 +667458,7 @@ "operationId": "users/delete-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#delete-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#delete-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -666755,12 +667690,12 @@ "operationId": "users/list-followers-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-followers-of-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -666769,7 +667704,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -667020,12 +667955,12 @@ "operationId": "users/list-followed-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-the-authenticated-user-follows" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-the-people-the-authenticated-user-follows" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -667034,7 +667969,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -667285,7 +668220,7 @@ "operationId": "users/check-person-is-followed-by-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" }, "parameters": [ { @@ -667393,14 +668328,14 @@ }, "put": { "summary": "Follow a user", - "description": "Note that 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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", + "description": "Note that 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/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/follow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#follow-a-user" }, "parameters": [ { @@ -667584,7 +668519,7 @@ "operationId": "users/unfollow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#unfollow-a-user" }, "parameters": [ { @@ -667701,12 +668636,12 @@ "operationId": "users/list-gpg-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -667715,7 +668650,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -668061,7 +668996,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -668491,7 +669426,7 @@ "operationId": "users/get-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -668829,7 +669764,7 @@ "operationId": "users/delete-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -669015,12 +669950,12 @@ "operationId": "apps/list-installations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -669029,7 +669964,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -670150,7 +671085,7 @@ "operationId": "apps/list-installation-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" }, "parameters": [ { @@ -670169,7 +671104,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -670178,7 +671113,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -671174,7 +672109,7 @@ "operationId": "apps/add-repo-to-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#add-a-repository-to-an-app-installation" }, "parameters": [ { @@ -671277,7 +672212,7 @@ "operationId": "apps/remove-repo-from-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#remove-a-repository-from-an-app-installation" }, "parameters": [ { @@ -671385,7 +672320,7 @@ "operationId": "interactions/get-restrictions-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#get-interaction-restrictions-for-your-public-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories" }, "responses": { "200": { @@ -671464,7 +672399,7 @@ "operationId": "interactions/set-restrictions-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#set-interaction-restrictions-for-your-public-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories" }, "requestBody": { "required": true, @@ -671647,7 +672582,7 @@ "operationId": "interactions/remove-restrictions-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories" }, "responses": { "204": { @@ -671665,14 +672600,14 @@ "/user/issues": { "get": { "summary": "List user account issues assigned to the authenticated user", - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -671758,7 +672693,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -671767,7 +672702,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -675064,12 +675999,12 @@ "operationId": "users/list-public-ssh-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -675078,7 +676013,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -675271,7 +676206,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -675541,7 +676476,7 @@ "operationId": "users/get-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -675717,7 +676652,7 @@ "operationId": "users/delete-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -675834,12 +676769,12 @@ "operationId": "apps/list-subscriptions-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -675848,7 +676783,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -676162,12 +677097,12 @@ "operationId": "apps/list-subscriptions-for-authenticated-user-stubbed", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -676176,7 +677111,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -676464,7 +677399,7 @@ "operationId": "orgs/list-memberships-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-memberships-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" }, "parameters": [ { @@ -676482,7 +677417,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -676491,7 +677426,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -677024,7 +677959,7 @@ "operationId": "orgs/get-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -677433,7 +678368,7 @@ "operationId": "orgs/update-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -677942,12 +678877,12 @@ "operationId": "migrations/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-user-migrations" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -677956,7 +678891,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -679182,7 +680117,7 @@ "operationId": "migrations/start-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#start-a-user-migration" }, "parameters": [], "requestBody": { @@ -680545,14 +681480,14 @@ "/user/migrations/{migration_id}": { "get": { "summary": "Get a user migration status", - "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive).", + "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#download-a-user-migration-archive).", "tags": [ "migrations" ], "operationId": "migrations/get-status-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#get-a-user-migration-status" }, "parameters": [ { @@ -681810,7 +682745,7 @@ "operationId": "migrations/get-archive-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#download-a-user-migration-archive" }, "parameters": [ { @@ -681892,14 +682827,14 @@ }, "delete": { "summary": "Delete a user migration archive", - "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.", + "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.", "tags": [ "migrations" ], "operationId": "migrations/delete-archive-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#delete-a-user-migration-archive" }, "parameters": [ { @@ -682009,14 +682944,14 @@ "/user/migrations/{migration_id}/repos/{repo_name}/lock": { "delete": { "summary": "Unlock a user repository", - "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", + "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", "tags": [ "migrations" ], "operationId": "migrations/unlock-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository" }, "parameters": [ { @@ -682142,7 +683077,7 @@ "operationId": "migrations/list-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-repositories-for-a-user-migration" }, "parameters": [ { @@ -682156,7 +683091,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -682165,7 +683100,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -683131,12 +684066,12 @@ "operationId": "orgs/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -683145,7 +684080,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -683332,14 +684267,14 @@ "/user/packages": { "get": { "summary": "List packages for the authenticated user's namespace", - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-the-authenticated-users-namespace" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" }, "parameters": [ { @@ -683361,7 +684296,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor 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).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor 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).\"", "in": "query", "required": false, "schema": { @@ -683375,7 +684310,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -683384,7 +684319,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -684448,14 +685383,14 @@ "/user/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for the authenticated user", - "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -685567,14 +686502,14 @@ }, "delete": { "summary": "Delete a package for the authenticated user", - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -685698,14 +686633,14 @@ "/user/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for the authenticated user", - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -685838,14 +686773,14 @@ "/user/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by the authenticated user", - "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" }, "parameters": [ { @@ -685876,7 +686811,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -685885,7 +686820,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -686156,14 +687091,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -686351,14 +687286,14 @@ }, "delete": { "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -686491,14 +687426,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -686631,19 +687566,19 @@ "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", - "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", + "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/list-public-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-public-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -686652,7 +687587,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -686822,7 +687757,7 @@ "operationId": "repos/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repositories-for-the-authenticated-user" }, "parameters": [ { @@ -686898,7 +687833,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -686907,7 +687842,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -687969,7 +688904,7 @@ "operationId": "repos/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -692167,12 +693102,12 @@ "operationId": "repos/list-invitations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -692181,7 +693116,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -693505,7 +694440,7 @@ "operationId": "repos/accept-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#accept-a-repository-invitation" }, "parameters": [ { @@ -693620,7 +694555,7 @@ "operationId": "repos/decline-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#decline-a-repository-invitation" }, "parameters": [ { @@ -693737,12 +694672,12 @@ "operationId": "users/list-social-accounts-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -693751,7 +694686,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -693905,7 +694840,7 @@ "operationId": "users/add-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -694156,7 +695091,7 @@ "operationId": "users/delete-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -694373,12 +695308,12 @@ "operationId": "users/list-ssh-signing-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -694387,7 +695322,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -694557,7 +695492,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -694572,7 +695507,7 @@ "example": "Personal MacBook Air" }, "key": { - "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest//authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", "type": "string", "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " } @@ -694806,7 +695741,7 @@ "operationId": "users/get-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -694961,7 +695896,7 @@ "operationId": "users/delete-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -695071,14 +696006,14 @@ "/user/starred": { "get": { "summary": "List repositories starred by the authenticated user", - "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" }, "parameters": [ { @@ -695111,7 +696046,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -695120,7 +696055,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -696992,7 +697927,7 @@ "operationId": "activity/check-repo-is-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" }, "parameters": [ { @@ -697109,14 +698044,14 @@ }, "put": { "summary": "Star a repository for the authenticated user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "activity" ], "operationId": "activity/star-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#star-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -697240,7 +698175,7 @@ "operationId": "activity/unstar-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -697366,12 +698301,12 @@ "operationId": "activity/list-watched-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -697380,7 +698315,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -698375,12 +699310,12 @@ "operationId": "teams/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-teams-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -698389,7 +699324,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -699040,14 +699975,14 @@ "/user/{account_id}": { "get": { "summary": "Get a user using their ID", - "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails).", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest/rest/users/emails).", "tags": [ "users" ], "operationId": "users/get-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-a-user-using-their-id" }, "parameters": [ { @@ -699663,7 +700598,7 @@ "operationId": "projects/create-draft-item-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-user-owned-project" }, "parameters": [ { @@ -706385,14 +707320,14 @@ "/users": { "get": { "summary": "List users", - "description": "Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "description": "Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", "tags": [ "users" ], "operationId": "users/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users" }, "parameters": [ { @@ -706406,7 +707341,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -706605,7 +707540,7 @@ "operationId": "projects/create-view-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-a-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-a-user-owned-project" }, "parameters": [ { @@ -706651,7 +707586,7 @@ }, "filter": { "type": "string", - "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", "example": "is:issue is:open" }, "visible_fields": { @@ -707328,14 +708263,14 @@ "/users/{username}": { "get": { "summary": "Get a user", - "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails).", + "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest/rest/users/emails).", "tags": [ "users" ], "operationId": "users/get-by-username", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-a-user" }, "parameters": [ { @@ -707944,19 +708879,19 @@ "/users/{username}/attestations/bulk-list": { "post": { "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "users" ], "operationId": "users/list-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#list-attestations-by-bulk-subject-digests" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -707965,7 +708900,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -707974,7 +708909,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -708264,7 +709199,7 @@ "operationId": "users/delete-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-in-bulk" }, "parameters": [ { @@ -708391,7 +709326,7 @@ "operationId": "users/delete-attestations-by-subject-digest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-by-subject-digest" }, "parameters": [ { @@ -708466,7 +709401,7 @@ "operationId": "users/delete-attestations-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-by-id" }, "parameters": [ { @@ -708559,19 +709494,19 @@ "/users/{username}/attestations/{subject_digest}": { "get": { "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "users" ], "operationId": "users/list-attestations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#list-attestations" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -708580,7 +709515,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -708589,7 +709524,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -708871,7 +709806,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" }, "parameters": [ { @@ -709996,7 +710931,7 @@ "operationId": "activity/list-events-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-events-for-the-authenticated-user" }, "parameters": [ { @@ -710010,7 +710945,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -710019,7 +710954,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -720323,7 +721258,7 @@ "operationId": "activity/list-org-events-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-organization-events-for-the-authenticated-user" }, "parameters": [ { @@ -720346,7 +721281,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -720355,7 +721290,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -730678,7 +731613,7 @@ "operationId": "activity/list-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-user" }, "parameters": [ { @@ -730692,7 +731627,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -730701,7 +731636,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -741005,7 +741940,7 @@ "operationId": "users/list-followers-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-followers-of-a-user" }, "parameters": [ { @@ -741019,7 +741954,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -741028,7 +741963,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -741224,7 +742159,7 @@ "operationId": "users/list-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-the-people-a-user-follows" }, "parameters": [ { @@ -741238,7 +742173,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -741247,7 +742182,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -741443,7 +742378,7 @@ "operationId": "users/check-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#check-if-a-user-follows-another-user" }, "parameters": [ { @@ -741490,7 +742425,7 @@ "operationId": "gists/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gists-for-a-user" }, "parameters": [ { @@ -741514,7 +742449,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -741523,7 +742458,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -742059,7 +742994,7 @@ "operationId": "users/list-gpg-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#list-gpg-keys-for-a-user" }, "parameters": [ { @@ -742073,7 +743008,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -742082,7 +743017,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -742349,7 +743284,7 @@ "operationId": "users/get-context-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-contextual-information-for-a-user" }, "parameters": [ { @@ -742541,14 +743476,14 @@ "/users/{username}/installation": { "get": { "summary": "Get a user installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-user-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" }, "parameters": [ { @@ -743542,7 +744477,7 @@ "operationId": "users/list-public-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#list-public-keys-for-a-user" }, "parameters": [ { @@ -743556,7 +744491,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -743565,7 +744500,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -743640,14 +744575,14 @@ "/users/{username}/orgs": { "get": { "summary": "List organizations for a user", - "description": "List [public organization memberships](https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/enterprise-cloud@latest/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", "tags": [ "orgs" ], "operationId": "orgs/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-a-user" }, "parameters": [ { @@ -743661,7 +744596,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -743670,7 +744605,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -743802,14 +744737,14 @@ "/users/{username}/packages": { "get": { "summary": "List packages for a user", - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-a-user" }, "parameters": [ { @@ -743831,7 +744766,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor 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).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor 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).\"", "in": "query", "required": false, "schema": { @@ -743854,7 +744789,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -743863,7 +744798,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -744979,14 +745914,14 @@ "/users/{username}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for a user", - "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-a-user" }, "parameters": [ { @@ -746107,14 +747042,14 @@ }, "delete": { "summary": "Delete a package for a user", - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-a-user" }, "parameters": [ { @@ -746247,14 +747182,14 @@ "/users/{username}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for a user", - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-a-user" }, "parameters": [ { @@ -746396,14 +747331,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by a user", - "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" }, "parameters": [ { @@ -746700,14 +747635,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for a user", - "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-a-user" }, "parameters": [ { @@ -746901,14 +747836,14 @@ }, "delete": { "summary": "Delete package version for a user", - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-package-version-for-a-user" }, "parameters": [ { @@ -747050,14 +747985,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for a user", - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-package-version-for-a-user" }, "parameters": [ { @@ -747206,7 +748141,7 @@ "operationId": "projects/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#list-projects-for-user" }, "parameters": [ { @@ -747229,7 +748164,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -747238,7 +748173,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -747247,7 +748182,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -748094,7 +749029,7 @@ "operationId": "projects/get-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#get-project-for-user" }, "parameters": [ { @@ -748952,7 +749887,7 @@ "operationId": "projects/list-fields-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#list-project-fields-for-user" }, "parameters": [ { @@ -748975,7 +749910,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -748984,7 +749919,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -748993,7 +749928,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -749442,7 +750377,7 @@ "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { @@ -750166,7 +751101,7 @@ "operationId": "projects/get-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user" }, "parameters": [ { @@ -750528,7 +751463,7 @@ "operationId": "projects/list-items-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-a-user-owned-project" }, "parameters": [ { @@ -750551,7 +751486,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -750560,7 +751495,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -750569,7 +751504,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -750578,7 +751513,7 @@ }, { "name": "q", - "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", "in": "query", "required": false, "schema": { @@ -751654,7 +752589,7 @@ "operationId": "projects/add-item-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#add-item-to-user-owned-project" }, "parameters": [ { @@ -758625,7 +759560,7 @@ "operationId": "projects/get-user-item", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#get-an-item-for-a-user-owned-project" }, "parameters": [ { @@ -759721,7 +760656,7 @@ "operationId": "projects/update-item-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#update-project-item-for-user" }, "parameters": [ { @@ -763995,7 +764930,7 @@ "operationId": "projects/delete-item-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#delete-project-item-for-user" }, "parameters": [ { @@ -764101,7 +765036,7 @@ "operationId": "projects/list-view-items-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-project-view" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-a-user-project-view" }, "parameters": [ { @@ -764153,7 +765088,7 @@ }, { "name": "before", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -764162,7 +765097,7 @@ }, { "name": "after", - "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -764171,7 +765106,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -765255,7 +766190,7 @@ "operationId": "activity/list-received-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-events-received-by-the-authenticated-user" }, "parameters": [ { @@ -765269,7 +766204,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -765278,7 +766213,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -775587,7 +776522,7 @@ "operationId": "activity/list-received-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-received-by-a-user" }, "parameters": [ { @@ -775601,7 +776536,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -775610,7 +776545,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -785919,7 +786854,7 @@ "operationId": "repos/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repositories-for-a-user" }, "parameters": [ { @@ -785977,7 +786912,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -785986,7 +786921,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -786926,7 +787861,7 @@ "operationId": "users/list-social-accounts-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#list-social-accounts-for-a-user" }, "parameters": [ { @@ -786940,7 +787875,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -786949,7 +787884,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -787024,7 +787959,7 @@ "operationId": "users/list-ssh-signing-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" }, "parameters": [ { @@ -787038,7 +787973,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -787047,7 +787982,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -787130,14 +788065,14 @@ "/users/{username}/starred": { "get": { "summary": "List repositories starred by a user", - "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user" }, "parameters": [ { @@ -787179,7 +788114,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -787188,7 +788123,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -788874,7 +789809,7 @@ "operationId": "activity/list-repos-watched-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-repositories-watched-by-a-user" }, "parameters": [ { @@ -788888,7 +789823,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -788897,7 +789832,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -789837,7 +790772,7 @@ "operationId": "meta/get-all-versions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-all-api-versions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-all-api-versions" }, "responses": { "200": { @@ -789909,7 +790844,7 @@ "operationId": "meta/get-zen", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-the-zen-of-github" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-the-zen-of-github" }, "responses": { "200": { @@ -789941,11 +790876,11 @@ "x-webhooks": { "branch-protection-configuration-disabled": { "post": { - "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "All branch protections were disabled for a repository.", "operationId": "branch-protection-configuration/disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { @@ -790021,7 +790956,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -790089,7 +791024,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -791565,11 +792500,11 @@ }, "branch-protection-configuration-enabled": { "post": { - "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "All branch protections were enabled for a repository.", "operationId": "branch-protection-configuration/enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { @@ -791645,7 +792580,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -791713,7 +792648,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -793189,11 +794124,11 @@ }, "branch-protection-rule-created": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A branch protection rule was created.", "operationId": "branch-protection-rule/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -793269,7 +794204,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -793337,7 +794272,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -794662,7 +795597,7 @@ }, "rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -794993,11 +795928,11 @@ }, "branch-protection-rule-deleted": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A branch protection rule was deleted.", "operationId": "branch-protection-rule/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -795073,7 +796008,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -795141,7 +796076,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -796466,7 +797401,7 @@ }, "rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -796797,11 +797732,11 @@ }, "branch-protection-rule-edited": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A branch protection rule was edited.", "operationId": "branch-protection-rule/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -797035,7 +797970,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -797103,7 +798038,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -798428,7 +799363,7 @@ }, "rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -798759,11 +799694,11 @@ }, "bypass-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass request was cancelled.", "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -798839,7 +799774,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -798907,7 +799842,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -800825,11 +801760,11 @@ }, "bypass-request-secret-scanning-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning bypass request was completed.", "operationId": "exemption-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -800905,7 +801840,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -800973,7 +801908,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -802891,11 +803826,11 @@ }, "bypass-request-secret-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass request was created.", "operationId": "exemption-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -802971,7 +803906,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -803039,7 +803974,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -804957,11 +805892,11 @@ }, "bypass-request-secret-scanning-response-dismissed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass response was dismissed.", "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -805037,7 +805972,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -805105,7 +806040,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -807062,11 +807997,11 @@ }, "bypass-request-secret-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -807142,7 +808077,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -807210,7 +808145,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -809167,11 +810102,11 @@ }, "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -811423,7 +812358,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -811444,7 +812379,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -813312,11 +814247,11 @@ }, "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -815568,7 +816503,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -815589,7 +816524,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -817457,11 +818392,11 @@ }, "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -819713,7 +820648,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -819734,7 +820669,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -821615,11 +822550,11 @@ }, "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -823871,7 +824806,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -823892,7 +824827,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -825760,11 +826695,11 @@ }, "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -825839,7 +826774,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -826588,7 +827523,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -826656,7 +827591,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -828133,11 +829068,11 @@ }, "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -828212,7 +829147,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -828994,7 +829929,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -829062,7 +829997,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -830539,11 +831474,11 @@ }, "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -830618,7 +831553,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -831394,7 +832329,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -831462,7 +832397,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -832939,11 +833874,11 @@ }, "code-scanning-alert-appeared-in-branch": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -833441,7 +834376,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -833509,7 +834444,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -834992,11 +835927,11 @@ }, "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "Someone closed a code scanning alert.", "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -835612,7 +836547,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -835680,7 +836615,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -837163,11 +838098,11 @@ }, "code-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A code scanning alert was created in a repository.", "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -837601,7 +838536,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -837669,7 +838604,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -839152,11 +840087,11 @@ }, "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A code scanning alert was fixed in a branch by a commit.", "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -839682,7 +840617,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -839750,7 +840685,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -841233,11 +842168,11 @@ }, "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A previously fixed code scanning alert reappeared in a branch.", "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -841674,7 +842609,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -841742,7 +842677,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -843226,11 +844161,11 @@ }, "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "Someone reopened a code scanning alert.", "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -843626,7 +844561,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -843694,7 +844629,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -845177,11 +846112,11 @@ }, "code-scanning-alert-updated-assignment": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "The assignees list of a code scanning alert has been updated.", "operationId": "code-scanning-alert/updated-assignment", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -845675,7 +846610,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -845743,7 +846678,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -847220,11 +848155,11 @@ }, "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -847527,7 +848462,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -847595,7 +848530,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -849075,7 +850010,7 @@ "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -849150,7 +850085,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -849218,7 +850153,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -849319,7 +850254,7 @@ "type": "string" }, "ref": { - "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource.", + "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource.", "type": "string" }, "ref_type": { @@ -850718,11 +851653,11 @@ }, "custom-property-created": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A new custom property was created.", "operationId": "custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -850885,7 +851820,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -850953,7 +851888,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -851197,11 +852132,11 @@ }, "custom-property-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was deleted.", "operationId": "custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -851289,7 +852224,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -851357,7 +852292,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -851601,11 +852536,11 @@ }, "custom-property-promoted-to-enterprise": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was promoted to an enterprise.", "operationId": "custom-property/promote-to-enterprise", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -851768,7 +852703,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -851836,7 +852771,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -852080,11 +853015,11 @@ }, "custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was updated.", "operationId": "custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -852247,7 +853182,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -852315,7 +853250,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -852559,11 +853494,11 @@ }, "custom-property-values-updated": { "post": { - "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "The custom property values of a repository were updated.", "operationId": "custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom-property-values" }, "parameters": [ { @@ -852639,7 +853574,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -852707,7 +853642,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -854256,7 +855191,7 @@ "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -854326,7 +855261,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -854394,7 +855329,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -854491,7 +855426,7 @@ "type": "string" }, "ref": { - "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource.", + "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource.", "type": "string" }, "ref_type": { @@ -855888,11 +856823,11 @@ }, "dependabot-alert-assignees-changed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "The assignees for a Dependabot alert were updated.", "operationId": "dependabot-alert/assignees-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -856828,7 +857763,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -856922,7 +857857,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -858373,11 +859308,11 @@ }, "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -859313,7 +860248,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -859407,7 +860342,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -860858,11 +861793,11 @@ }, "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -861798,7 +862733,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -861892,7 +862827,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -863343,11 +864278,11 @@ }, "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -864283,7 +865218,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -864377,7 +865312,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -865828,11 +866763,11 @@ }, "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was manually closed.", "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -866768,7 +867703,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -866862,7 +867797,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -868313,11 +869248,11 @@ }, "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A manifest file change removed a vulnerability.", "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -869253,7 +870188,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -869347,7 +870282,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -870798,11 +871733,11 @@ }, "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -871738,7 +872673,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -871832,7 +872767,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -873283,11 +874218,11 @@ }, "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was manually reopened.", "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -874223,7 +875158,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -874317,7 +875252,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -875768,11 +876703,11 @@ }, "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -875848,7 +876783,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -875916,7 +876851,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -875936,7 +876871,7 @@ ] }, "key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", "type": "object", "properties": { "added_by": { @@ -877441,11 +878376,11 @@ }, "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -877521,7 +878456,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -877589,7 +878524,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -877609,7 +878544,7 @@ ] }, "key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", "type": "object", "properties": { "added_by": { @@ -879114,11 +880049,11 @@ }, "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment was created.", "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -879194,7 +880129,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -879828,7 +880763,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -879896,7 +880831,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -882281,11 +883216,11 @@ }, "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment protection rule was requested for an environment.", "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -887521,7 +888456,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -887686,11 +888621,11 @@ }, "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was approved.", "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -887830,7 +888765,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -887898,7 +888833,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -890419,11 +891354,11 @@ }, "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was rejected.", "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -890563,7 +891498,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -890631,7 +891566,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -893152,11 +894087,11 @@ }, "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was requested.", "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -893231,7 +894166,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -893302,7 +894237,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -895894,11 +896829,11 @@ }, "deployment-status-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", "description": "A new deployment status was created.", "operationId": "deployment-status/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_status" }, "parameters": [ { @@ -896060,7 +896995,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -896694,7 +897629,7 @@ ] }, "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses).", + "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses).", "type": "object", "properties": { "created_at": { @@ -897313,7 +898248,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -897381,7 +898316,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -899767,11 +900702,11 @@ }, "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was marked as the answer.", "operationId": "discussion/answered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -900517,7 +901452,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -900585,7 +901520,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -902063,11 +902998,11 @@ }, "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The category of a discussion was changed.", "operationId": "discussion/category-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -902665,7 +903600,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -902733,7 +903668,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -904211,11 +905146,11 @@ }, "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was closed.", "operationId": "discussion/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -904750,7 +905685,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -904818,7 +905753,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -906295,11 +907230,11 @@ }, "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was created.", "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -907045,7 +907980,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -907113,7 +908048,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -908591,11 +909526,11 @@ }, "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was deleted.", "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -909341,7 +910276,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -909409,7 +910344,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -910887,11 +911822,11 @@ }, "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was edited.", "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -911656,7 +912591,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -911724,7 +912659,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -913203,11 +914138,11 @@ }, "discussion-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was created.", "operationId": "discussion/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -913742,7 +914677,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -913810,7 +914745,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -915287,11 +916222,11 @@ }, "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was deleted.", "operationId": "discussion/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -915826,7 +916761,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -915894,7 +916829,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -917371,11 +918306,11 @@ }, "discussion-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", "operationId": "discussion/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -917937,7 +918872,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -918005,7 +918940,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -919482,11 +920417,11 @@ }, "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was added to a discussion.", "operationId": "discussion/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -920021,7 +920956,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -920089,7 +921024,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -921608,11 +922543,11 @@ }, "discussion-locked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was locked.", "operationId": "discussion/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -922147,7 +923082,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -922215,7 +923150,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -923692,11 +924627,11 @@ }, "discussion-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was pinned.", "operationId": "discussion/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -924231,7 +925166,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -924299,7 +925234,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -925776,11 +926711,11 @@ }, "discussion-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was reopened.", "operationId": "discussion/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -926315,7 +927250,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -926383,7 +927318,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -927860,11 +928795,11 @@ }, "discussion-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was transferred to another repository.", "operationId": "discussion/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -930098,7 +931033,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -930166,7 +931101,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -931644,11 +932579,11 @@ }, "discussion-unanswered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was unmarked as the answer.", "operationId": "discussion/unanswered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -933850,11 +934785,11 @@ }, "discussion-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was removed from a discussion.", "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -934389,7 +935324,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -934457,7 +935392,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -935976,11 +936911,11 @@ }, "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unlocked.", "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -936515,7 +937450,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -936583,7 +937518,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -938060,11 +938995,11 @@ }, "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unpinned.", "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -938599,7 +939534,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -938667,7 +939602,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -940148,7 +941083,7 @@ "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -940224,7 +941159,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -940292,7 +941227,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -942214,7 +943149,7 @@ "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -942290,7 +943225,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -942358,7 +943293,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -944319,7 +945254,7 @@ "description": "A Dependabot alert dismissal request was canceled.", "operationId": "dismissal-request-dependabot/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { @@ -944395,7 +945330,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -944463,7 +945398,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -946385,7 +947320,7 @@ "description": "A Dependabot alert dismissal request was created.", "operationId": "dismissal-request-dependabot/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { @@ -946461,7 +947396,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -946529,7 +947464,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -948451,7 +949386,7 @@ "description": "A Dependabot alert dismissal request received a response.", "operationId": "dismissal-request-dependabot/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { @@ -948527,7 +949462,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -948595,7 +949530,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -950556,7 +951491,7 @@ "description": "A secret scanning alert dismissal request was canceled.", "operationId": "dismissal-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -950632,7 +951567,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -950700,7 +951635,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -952622,7 +953557,7 @@ "description": "A secret scanning alert dismissal request was completed.", "operationId": "dismissal-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -952698,7 +953633,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -952766,7 +953701,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -954688,7 +955623,7 @@ "description": "A secret scanning alert dismissal request was created.", "operationId": "dismissal-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -954764,7 +955699,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -954832,7 +955767,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -956754,7 +957689,7 @@ "description": "A secret scanning alert dismissal response was dismissed.", "operationId": "dismissal-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -956830,7 +957765,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -956898,7 +957833,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -958859,7 +959794,7 @@ "description": "A secret scanning alert dismissal response was submitted.", "operationId": "dismissal-request-secret-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -958935,7 +959870,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -959003,7 +959938,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -960960,11 +961895,11 @@ }, "exemption-request-push-ruleset-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was cancelled.", "operationId": "exemption-request-push-ruleset/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -961040,7 +961975,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -961108,7 +962043,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -963026,11 +963961,11 @@ }, "exemption-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was completed.", "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -963106,7 +964041,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -963174,7 +964109,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -965092,11 +966027,11 @@ }, "exemption-request-push-ruleset-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was created.", "operationId": "exemption-request-push-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -965172,7 +966107,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -965240,7 +966175,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -967158,11 +968093,11 @@ }, "exemption-request-push-ruleset-response-dismissed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass response was dismissed.", "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -967238,7 +968173,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -967306,7 +968241,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -969263,11 +970198,11 @@ }, "exemption-request-push-ruleset-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -969343,7 +970278,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -969411,7 +970346,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -971368,10 +972303,10 @@ }, "fork": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest/rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -971442,7 +972377,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -971509,7 +972444,7 @@ ] }, "forkee": { - "description": "The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource.", + "description": "The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource.", "allOf": [ { "title": "Repository", @@ -972415,7 +973350,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -973892,11 +974827,11 @@ }, "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", "description": "Someone revoked their authorization of a GitHub App.", "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -974120,10 +975055,10 @@ }, "gollum": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -974193,7 +975128,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -974261,7 +975196,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -975783,11 +976718,11 @@ }, "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Someone installed a GitHub App on a user or organization account.", "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -975863,7 +976798,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -978413,11 +979348,11 @@ }, "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Someone uninstalled a GitHub App from their user or organization account.", "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -978493,7 +979428,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -980950,11 +981885,11 @@ }, "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Someone granted new permissions to a GitHub App.", "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -981030,7 +981965,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -983487,11 +984422,11 @@ }, "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "A GitHub App installation was granted access to one or more repositories.", "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -983567,7 +984502,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -986156,11 +987091,11 @@ }, "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Access to one or more repositories was revoked for a GitHub App installation.", "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -986236,7 +987171,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -988832,11 +989767,11 @@ }, "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Someone blocked access by a GitHub App to their user or organization account.", "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -988912,7 +989847,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -991369,11 +992304,11 @@ }, "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -991598,7 +992533,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -991666,7 +992601,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -993145,11 +994080,11 @@ }, "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -993225,7 +994160,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -995682,11 +996617,11 @@ }, "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was created.", "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -995762,7 +996697,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -996427,7 +997362,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -996495,7 +997430,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -996515,11 +997450,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -999599,11 +1000534,11 @@ }, "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was deleted.", "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -999679,7 +1000614,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1000345,7 +1001280,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1000413,7 +1001348,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1000433,11 +1001368,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1003516,11 +1004451,11 @@ }, "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was edited.", "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -1003614,7 +1004549,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1004280,7 +1005215,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1004348,7 +1005283,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1004368,11 +1005303,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1007452,11 +1008387,11 @@ }, "issue-comment-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue was pinned.", "operationId": "issue-comment/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -1007532,7 +1008467,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1008198,7 +1009133,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1008266,7 +1009201,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1008286,11 +1009221,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1011376,11 +1012311,11 @@ }, "issue-comment-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue was unpinned.", "operationId": "issue-comment/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -1011456,7 +1012391,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1012122,7 +1013057,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1012190,7 +1013125,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1012210,11 +1013145,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1015304,7 +1016239,7 @@ "description": "An issue was marked as blocked by another issue.", "operationId": "issue-dependencies/blocked-by-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -1022044,7 +1022979,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1023525,7 +1024460,7 @@ "description": "The blocked by relationship between an issue and another issue was removed.", "operationId": "issue-dependencies/blocked-by-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -1030265,7 +1031200,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1031746,7 +1032681,7 @@ "description": "An issue was marked as blocking another issue.", "operationId": "issue-dependencies/blocking-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -1038486,7 +1039421,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1039967,7 +1040902,7 @@ "description": "The blocking relationship between an issue and another issue was removed.", "operationId": "issue-dependencies/blocking-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -1046707,7 +1047642,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1048184,11 +1049119,11 @@ }, "issues-assigned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was assigned to a user.", "operationId": "issues/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1048361,7 +1049296,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1048429,7 +1049364,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1048450,7 +1049385,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1051983,11 +1052918,11 @@ }, "issues-closed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was closed.", "operationId": "issues/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1052064,7 +1052999,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1052132,7 +1053067,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1052152,11 +1053087,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1053871,567 +1054806,8141 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "type": "object", + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-demilestoned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues demilestoned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "demilestoned" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "pinned_at", - "pinned_by" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" ], - "nullable": true + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ "id", "node_id", + "owner", + "name", + "description", + "external_url", "html_url", - "issue_url", - "user", - "url", "created_at", - "updated_at" - ], - "nullable": true + "updated_at", + "permissions", + "events" + ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "total": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { "type": "integer" }, - "completed": { + "+1": { "type": "integer" }, - "percent_completed": { + "-1": { "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { + }, + "laugh": { "type": "integer" }, - "blocking": { + "confused": { "type": "integer" }, - "total_blocked_by": { + "heart": { "type": "integer" }, - "total_blocking": { + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { "type": "integer" } }, "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", + "pin": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", + "id": { + "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, - "node_id": { + "name": { + "description": "The name of the option", "type": "string", - "example": "IFT_GDKND" + "example": "High" }, - "data_type": { - "description": "The data type of the issue field", + "color": { + "description": "The color of the option", "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true + "example": "red" } }, "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] + "id", + "name", + "color" + ], + "nullable": true } }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "state_reason": { + "node_id": { "type": "string", - "nullable": true + "description": "The node identifier of the issue type." }, - "timeline_url": { + "name": { "type": "string", - "format": "uri" + "description": "The name of the issue type." }, - "title": { - "description": "Title of the issue", - "type": "string" + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, - "updated_at": { + "created_at": { "type": "string", + "description": "The time the issue type created.", "format": "date-time" }, - "url": { - "description": "URL for the issue", + "updated_at": { "type": "string", - "format": "uri" + "description": "The time the issue type last updated.", + "format": "date-time" }, - "user": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "name", + "description" ] }, - { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "active_lock_reason": { + "avatar_url": { "type": "string", - "nullable": true + "format": "uri" }, - "assignee": { - "type": "object", - "nullable": true + "deleted": { + "type": "boolean" }, - "assignees": { - "type": "array", - "items": { - "type": "object", - "nullable": true - } + "email": { + "type": "string", + "nullable": true }, - "author_association": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "body": { + "followers_url": { "type": "string", - "nullable": true + "format": "uri" }, - "closed_at": { + "following_url": { "type": "string", - "nullable": true + "format": "uri-template" }, - "comments": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "comments_url": { + "gravatar_id": { "type": "string" }, - "created_at": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string" }, - "events_url": { + "name": { "type": "string" }, - "html_url": { + "node_id": { "type": "string" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "labels": { - "type": "array", - "items": { - "type": "object", - "nullable": true - } + "received_events_url": { + "type": "string", + "format": "uri" }, - "labels_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "locked": { + "site_admin": { "type": "boolean" }, - "milestone": { - "type": "object", - "nullable": true + "starred_url": { + "type": "string", + "format": "uri-template" }, - "node_id": { + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { "type": "string" + } + } + } + } + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "number": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "performed_via_github_app": { - "type": "object", + "email": { + "type": "string", "nullable": true }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } + "events_url": { + "type": "string", + "format": "uri-template" }, - "repository_url": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "state": { + "html_url": { "type": "string", - "enum": [ - "closed", - "open" - ] + "format": "uri" }, - "timeline_url": { + "id": { + "type": "integer" + }, + "login": { "type": "string" }, - "title": { + "name": { "type": "string" }, - "updated_at": { + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, "url": { - "type": "string" + "type": "string", + "format": "uri" }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user_view_type": { - "type": "string" - } - } + "user_view_type": { + "type": "string" } }, "required": [ - "state", - "closed_at" + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -1055890,13 +1064399,13 @@ } } }, - "issues-deleted": { + "issues-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1055961,18 +1064470,48 @@ "content": { "application/json": { "schema": { - "title": "issues deleted event", + "title": "issues edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "edited" ] }, + "changes": { + "description": "The changes to the issue.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1056040,7 +1064579,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1056061,7 +1064600,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1056154,7 +1064693,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1056251,15 +1064791,13 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } }, "required": [ @@ -1056467,7 +1065005,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1056625,6 +1065164,8 @@ "watch", "workflow_dispatch", "workflow_run", + "security_and_analysis", + "pull_request_review_thread", "reminder" ] } @@ -1056872,7 +1065413,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -1057936,10 +1066478,6 @@ "type": "string", "format": "uri" }, - "title": { - "description": "Title of the issue", - "type": "string" - }, "type": { "title": "Issue Type", "description": "The type of issue.", @@ -1058000,6 +1066538,10 @@ "description" ] }, + "title": { + "description": "Title of the issue", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time" @@ -1058089,7 +1066631,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1058130,6 +1066673,47 @@ "reactions" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1059561,6 +1068145,7 @@ }, "required": [ "action", + "changes", "issue", "repository", "sender" @@ -1059586,13 +1068171,13 @@ } } }, - "issues-demilestoned": { + "issues-field-added": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue field value was set or updated on an issue.", + "operationId": "issues/field-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1059657,18 +1068242,18 @@ "content": { "application/json": { "schema": { - "title": "issues demilestoned event", + "title": "issues field_added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "demilestoned" + "field_added" ] }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1059736,7 +1068321,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1059757,31 +1068342,8 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", - "required": [ - "active_lock_reason", - "assignees", - "author_association", - "body", - "closed_at", - "comments", - "comments_url", - "created_at", - "events_url", - "html_url", - "id", - "labels_url", - "milestone", - "node_id", - "number", - "reactions", - "repository_url", - "title", - "updated_at", - "url", - "user" - ], "properties": { "active_lock_reason": { "type": "string", @@ -1059798,10 +1068360,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1059884,8 +1068442,15 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "assignees": { "type": "array", @@ -1059893,10 +1068458,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1059979,8 +1068540,15 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "login", + "id" + ] } }, "author_association": { @@ -1060039,16 +1068607,6 @@ "items": { "title": "Label", "type": "object", - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ], - "nullable": true, "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", @@ -1060076,7 +1068634,16 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] } }, "labels_url": { @@ -1060091,24 +1068658,6 @@ "description": "A collection of related issues and pull requests.", "type": "object", "nullable": true, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ], "properties": { "closed_at": { "type": "string", @@ -1060126,10 +1068675,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1060216,7 +1068761,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "description": { "type": "string", @@ -1060268,7 +1068817,25 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, "node_id": { "type": "string" @@ -1060281,17 +1068848,6 @@ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ], "properties": { "created_at": { "type": "string", @@ -1060352,7 +1068908,9 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run" + "workflow_run", + "reminder", + "pull_request_review_thread" ] } }, @@ -1060381,10 +1068939,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1060470,7 +1069024,11 @@ "user_view_type": { "type": "string" } - } + }, + "required": [ + "login", + "id" + ] }, "permissions": { "description": "The set of permissions for the GitHub app", @@ -1060726,7 +1069284,18 @@ "nullable": true, "format": "date-time" } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] }, "pull_request": { "type": "object", @@ -1060757,18 +1069326,6 @@ "reactions": { "title": "Reactions", "type": "object", - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ], "properties": { "+1": { "type": "integer" @@ -1060801,7 +1069358,19 @@ "type": "string", "format": "uri" } - } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, "repository_url": { "type": "string", @@ -1061730,10 +1070299,6 @@ "title": "User", "type": "object", "nullable": true, - "required": [ - "login", - "id" - ], "properties": { "avatar_url": { "type": "string", @@ -1061821,193 +1070386,183 @@ "user_view_type": { "type": "string" } - } - } - } - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } }, "required": [ "login", "id" ] - }, - "description": { - "type": "string", - "nullable": true - }, - "due_on": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "issue_field": { + "type": "object", + "description": "The issue field whose value was set or updated on the issue.", + "properties": { "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue field." }, - "labels_url": { + "name": { "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" + "description": "The name of the issue field." }, - "state": { - "description": "The state of the milestone.", + "field_type": { "type": "string", + "description": "The data type of the issue field.", "enum": [ - "open", - "closed" + "text", + "date", + "single_select", + "number" ] + } + }, + "required": [ + "id", + "name", + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was set or updated for the issue field. When updating an existing value, the previous value is available in `changes`.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] }, - "updated_at": { - "type": "string", - "format": "date-time" + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." }, - "url": { - "type": "string", - "format": "uri" + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } } }, "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" + "id" ] }, + "changes": { + "type": "object", + "description": "The previous field value, present when an existing value was updated.", + "properties": { + "issue_field_value": { + "type": "object", + "description": "The previous issue field value data.", + "properties": { + "from": { + "type": "object", + "description": "The previous value of the issue field before the update.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The previous value. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the previously selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The previously selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "from" + ] + } + } + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1063440,6 +1071995,7 @@ "required": [ "action", "issue", + "issue_field", "repository", "sender" ] @@ -1063464,13 +1072020,13 @@ } } }, - "issues-edited": { + "issues-field-removed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue field value was cleared from an issue.", + "operationId": "issues/field-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1063535,48 +1072091,18 @@ "content": { "application/json": { "schema": { - "title": "issues edited event", + "title": "issues field_removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "field_removed" ] }, - "changes": { - "description": "The changes to the issue.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "title": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the title.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1063644,7 +1072170,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1063665,7 +1072191,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1063863,6 +1072389,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -1064229,9 +1072758,8 @@ "watch", "workflow_dispatch", "workflow_run", - "security_and_analysis", - "pull_request_review_thread", - "reminder" + "reminder", + "pull_request_review_thread" ] } }, @@ -1065543,6 +1074071,10 @@ "type": "string", "format": "uri" }, + "title": { + "description": "Title of the issue", + "type": "string" + }, "type": { "title": "Issue Type", "description": "The type of issue.", @@ -1065603,10 +1074135,6 @@ "description" ] }, - "title": { - "description": "Title of the issue", - "type": "string" - }, "updated_at": { "type": "string", "format": "date-time" @@ -1065738,45 +1074266,84 @@ "reactions" ] }, - "label": { - "title": "Label", + "issue_field": { "type": "object", + "description": "The issue field whose value was cleared from the issue.", "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": "string", - "nullable": true - }, "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue field." }, "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" + "type": "string", + "description": "The name of the issue field." }, - "url": { - "description": "URL for the label", + "field_type": { "type": "string", - "format": "uri" + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] } }, "required": [ "id", - "node_id", - "url", "name", - "color", - "default", - "description" + "field_type" + ] + }, + "issue_field_value": { + "type": "object", + "description": "The value that was cleared from the issue field.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field value." + }, + "value": { + "description": "The value of the field. Present for text, date, and number field types.", + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "value_id": { + "type": "integer", + "description": "The identifier of the selected option. Present for single_select field types." + }, + "option": { + "type": "object", + "description": "The selected option details. Present for single_select field types.", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id" ] }, "organization": { @@ -1067210,8 +1075777,8 @@ }, "required": [ "action", - "changes", "issue", + "issue_field", "repository", "sender" ] @@ -1067238,11 +1075805,11 @@ }, "issues-labeled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A label was added to an issue.", "operationId": "issues/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1067318,7 +1075885,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1067386,7 +1075953,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1067407,7 +1075974,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1070978,11 +1079545,11 @@ }, "issues-locked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "issues/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1071058,7 +1079625,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1071126,7 +1079693,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1071147,7 +1079714,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1074680,11 +1083247,11 @@ }, "issues-milestoned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was added to a milestone.", "operationId": "issues/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1074760,7 +1083327,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1074828,7 +1083395,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1074849,7 +1083416,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1078557,11 +1087124,11 @@ }, "issues-opened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", "operationId": "issues/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1078640,7 +1087207,7 @@ "properties": { "old_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "nullable": true, "properties": { @@ -1081316,7 +1089883,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1081384,7 +1089951,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1081405,7 +1089972,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1084936,11 +1093503,11 @@ }, "issues-pinned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", "operationId": "issues/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1085016,7 +1093583,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1085084,7 +1093651,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1085105,7 +1093672,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1088631,11 +1097198,11 @@ }, "issues-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A closed issue was reopened.", "operationId": "issues/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1088711,7 +1097278,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1088779,7 +1097346,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1088800,7 +1097367,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1092329,11 +1100896,11 @@ }, "issues-transferred": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", "operationId": "issues/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1092412,7 +1100979,7 @@ "properties": { "new_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1095108,7 +1103675,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1095176,7 +1103743,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1095197,7 +1103764,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1098724,11 +1107291,11 @@ }, "issues-typed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue type was added to an issue.", "operationId": "issues/typed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1098804,7 +1107371,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1098872,7 +1107439,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1098893,7 +1107460,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1102487,11 +1111054,11 @@ }, "issues-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A user was unassigned from an issue.", "operationId": "issues/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1102664,7 +1111231,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1102732,7 +1111299,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1102753,7 +1111320,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1106286,11 +1114853,11 @@ }, "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A label was removed from an issue.", "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1106366,7 +1114933,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1106434,7 +1115001,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1106455,7 +1115022,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1110029,11 +1118596,11 @@ }, "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1110109,7 +1118676,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1110177,7 +1118744,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1110198,7 +1118765,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1113729,11 +1122296,11 @@ }, "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1113809,7 +1122376,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1113877,7 +1122444,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1113898,7 +1122465,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1117424,11 +1125991,11 @@ }, "issues-untyped": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue type was removed from an issue.", "operationId": "issues/untyped", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1117504,7 +1126071,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1117572,7 +1126139,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1117593,7 +1126160,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1121187,11 +1129754,11 @@ }, "label-created": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label was created.", "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -1121267,7 +1129834,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1121335,7 +1129902,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1122852,11 +1131419,11 @@ }, "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label was deleted.", "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -1122932,7 +1131499,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1123000,7 +1131567,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1124518,11 +1133085,11 @@ }, "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label's name, description, or color was changed.", "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -1124640,7 +1133207,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1124708,7 +1133275,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1126226,11 +1134793,11 @@ }, "marketplace-purchase-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1126309,7 +1134876,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1126377,7 +1134944,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1128075,11 +1136642,11 @@ }, "marketplace-purchase-changed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1128158,7 +1136725,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1128226,7 +1136793,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1129926,11 +1138493,11 @@ }, "marketplace-purchase-pending-change": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", "operationId": "marketplace-purchase/pending-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1130009,7 +1138576,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1130077,7 +1138644,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1131776,11 +1140343,11 @@ }, "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1131859,7 +1140426,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1131927,7 +1140494,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1133623,11 +1142190,11 @@ }, "marketplace-purchase-purchased": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/purchased", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1133706,7 +1142273,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1133774,7 +1142341,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1135472,11 +1144039,11 @@ }, "member-added": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -1135586,7 +1144153,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1135654,7 +1144221,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1137228,11 +1145795,11 @@ }, "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -1137339,7 +1145906,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1137407,7 +1145974,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1138982,11 +1147549,11 @@ }, "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -1139062,7 +1147629,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1139130,7 +1147697,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1140704,11 +1149271,11 @@ }, "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -1140784,7 +1149351,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1140852,7 +1149419,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1142587,11 +1151154,11 @@ }, "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -1142667,7 +1151234,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1142735,7 +1151302,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1144471,14 +1153038,14 @@ }, "merge-group-checks-requested": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -1144553,7 +1153120,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1146135,14 +1154702,14 @@ }, "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", "operationId": "merge-group/destroyed", "tags": [ "merge-queue" ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -1146226,7 +1154793,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1147812,7 +1156379,7 @@ "description": "The webhook was deleted.", "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -1147888,7 +1156455,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1148083,7 +1156650,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1149562,11 +1158129,11 @@ }, "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was closed.", "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1149642,7 +1158209,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1149710,7 +1158277,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1151370,11 +1159937,11 @@ }, "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was created.", "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1151450,7 +1160017,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1151518,7 +1160085,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1153177,11 +1161744,11 @@ }, "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was deleted.", "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1153257,7 +1161824,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1153325,7 +1161892,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1154985,11 +1163552,11 @@ }, "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was edited.", "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1155107,7 +1163674,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1155175,7 +1163742,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1156836,11 +1165403,11 @@ }, "milestone-opened": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was opened.", "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1156916,7 +1165483,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1156984,7 +1165551,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1158643,11 +1167210,11 @@ }, "org-block-blocked": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", "description": "A user was blocked from the organization.", "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -1158819,7 +1167386,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1158887,7 +1167454,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1160364,11 +1168931,11 @@ }, "org-block-unblocked": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", "description": "A previously blocked user was unblocked from the organization.", "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -1160540,7 +1169107,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1160608,7 +1169175,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1162089,7 +1170656,7 @@ "description": "A new organization custom property was created.", "operationId": "organization-custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -1162257,7 +1170824,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1162478,7 +1171045,7 @@ "description": "An organization custom property was deleted.", "operationId": "organization-custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -1162566,7 +1171133,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1162634,7 +1171201,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1162808,7 +1171375,7 @@ "description": "An organization custom property was updated.", "operationId": "organization-custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -1162976,7 +1171543,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1163044,7 +1171611,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1163218,7 +1171785,7 @@ "description": "The custom property values of an organization were updated.", "operationId": "organization-custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization-custom-property-values" }, "parameters": [ { @@ -1163294,7 +1171861,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1163362,7 +1171929,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1163677,11 +1172244,11 @@ }, "organization-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization was deleted.", "operationId": "organization/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1163757,7 +1172324,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1163825,7 +1172392,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1165442,11 +1174009,11 @@ }, "organization-member-added": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member accepted an invitation to join an organization.", "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1165522,7 +1174089,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1165590,7 +1174157,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1167208,11 +1175775,11 @@ }, "organization-member-invited": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member was invited to join the organization.", "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1167288,7 +1175855,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1167356,7 +1175923,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1169083,11 +1177650,11 @@ }, "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member was removed from the organization.", "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1169163,7 +1177730,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1169231,7 +1177798,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1170849,11 +1179416,11 @@ }, "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "The name of an organization was changed.", "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1170942,7 +1179509,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1171010,7 +1179577,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1172627,11 +1181194,11 @@ }, "package-published": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.", "description": "A package was published to a registry.", "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -1172707,7 +1181274,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1172775,7 +1181342,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1175099,11 +1183666,11 @@ }, "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.", "description": "A previously published package was updated.", "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -1175179,7 +1183746,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1175247,7 +1183814,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1177350,10 +1185917,10 @@ }, "page-build": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -1177422,7 +1185989,7 @@ "type": "object", "properties": { "build": { - "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-github-pages-builds) itself.", + "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-github-pages-builds) itself.", "type": "object", "properties": { "commit": { @@ -1177566,7 +1186133,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1177637,7 +1186204,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1179114,11 +1187681,11 @@ }, "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was approved.", "operationId": "personal-access-token-request/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -1179492,7 +1188059,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1179757,7 +1188324,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1179806,11 +1188373,11 @@ }, "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was cancelled by the requester.", "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -1180184,7 +1188751,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1180449,7 +1189016,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1180498,11 +1189065,11 @@ }, "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was created.", "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -1180876,7 +1189443,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1181141,7 +1189708,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1181189,11 +1189756,11 @@ }, "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was denied.", "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -1181640,7 +1190207,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1181832,7 +1190399,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1181884,7 +1190451,7 @@ "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -1181986,7 +1190553,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "url": { @@ -1183708,11 +1192275,11 @@ }, "project-card-converted": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A note in a project (classic) was converted to an issue.", "operationId": "project-card/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1183807,7 +1192374,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1183875,7 +1192442,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1185512,11 +1194079,11 @@ }, "project-card-created": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card was added to a project (classic).", "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1185592,7 +1194159,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1185660,7 +1194227,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1187296,11 +1195863,11 @@ }, "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card on a project (classic) was deleted.", "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1187376,7 +1195943,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1187444,7 +1196011,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1189083,11 +1197650,11 @@ }, "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A note on a project (classic) was edited.", "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1189183,7 +1197750,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1189251,7 +1197818,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1190888,11 +1199455,11 @@ }, "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card on a project (classic) was moved to another column or to another position in its column.", "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1190987,7 +1199554,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1191055,7 +1199622,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1192799,11 +1201366,11 @@ }, "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was closed.", "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1192879,7 +1201446,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1192947,7 +1201514,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1194589,11 +1203156,11 @@ }, "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was added to a project (classic).", "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -1194669,7 +1203236,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1194737,7 +1203304,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1196263,11 +1204830,11 @@ }, "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was deleted from a project (classic).", "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -1196343,7 +1204910,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1196411,7 +1204978,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1197938,11 +1206505,11 @@ }, "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "The name of a column on a project (classic) was changed.", "operationId": "project-column/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -1198034,7 +1206601,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1198102,7 +1206669,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1199629,11 +1208196,11 @@ }, "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was moved to a new position on a project (classic).", "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -1199709,7 +1208276,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1199777,7 +1208344,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1201304,11 +1209871,11 @@ }, "project-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was created.", "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1201384,7 +1209951,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1201452,7 +1210019,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1203094,11 +1211661,11 @@ }, "project-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was deleted.", "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1203174,7 +1211741,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1203242,7 +1211809,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1204884,11 +1213451,11 @@ }, "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "The name or description of a project (classic) was changed.", "operationId": "project/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1204994,7 +1213561,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1205062,7 +1213629,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1206703,11 +1215270,11 @@ }, "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was closed.", "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1206783,7 +1215350,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1206851,7 +1215418,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1208493,11 +1217060,11 @@ }, "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was closed.", "operationId": "projects-v2/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1208573,7 +1217140,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1209474,11 +1218041,11 @@ }, "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was created.", "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1209554,7 +1218121,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1210455,11 +1219022,11 @@ }, "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was deleted.", "operationId": "projects-v2/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1210535,7 +1219102,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1211436,11 +1220003,11 @@ }, "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The title, description, or README of a project in the organization was changed.", "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1211569,7 +1220136,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1212471,11 +1221038,11 @@ }, "projects-v2-item-archived": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1212571,7 +1221138,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1213001,11 +1221568,11 @@ }, "projects-v2-item-converted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A draft issue in an organization project was converted to an issue.", "operationId": "projects-v2-item/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1213098,7 +1221665,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1213528,11 +1222095,11 @@ }, "projects-v2-item-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was added to a project in the organization.", "operationId": "projects-v2-item/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1213608,7 +1222175,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1214037,11 +1222604,11 @@ }, "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was deleted from a project in the organization.", "operationId": "projects-v2-item/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1214117,7 +1222684,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1214546,11 +1223113,11 @@ }, "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1214831,7 +1223398,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1215260,11 +1223827,11 @@ }, "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", "operationId": "projects-v2-item/reordered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1215358,7 +1223925,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1215788,11 +1224355,11 @@ }, "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1215888,7 +1224455,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1216318,11 +1224885,11 @@ }, "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was reopened.", "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1216398,7 +1224965,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1217299,11 +1225866,11 @@ }, "projects-v2-status-update-created": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was added to a project in the organization.", "operationId": "projects-v2-status-update/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -1217379,7 +1225946,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1217815,11 +1226382,11 @@ }, "projects-v2-status-update-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was removed from a project in the organization.", "operationId": "projects-v2-status-update/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -1217895,7 +1226462,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1218331,11 +1226898,11 @@ }, "projects-v2-status-update-edited": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was edited on a project in the organization.", "operationId": "projects-v2-status-update/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -1218486,7 +1227053,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1218922,10 +1227489,10 @@ }, "public": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -1218995,7 +1227562,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1219063,7 +1227630,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1220538,11 +1229105,11 @@ }, "pull-request-assigned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was assigned to a user.", "operationId": "pull-request/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1220714,7 +1229281,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1220782,7 +1229349,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1225246,11 +1233813,11 @@ }, "pull-request-auto-merge-disabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1225326,7 +1233893,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1225394,7 +1233961,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1229852,11 +1238419,11 @@ }, "pull-request-auto-merge-enabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1229932,7 +1238499,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1230000,7 +1238567,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1234457,11 +1243024,11 @@ }, "pull-request-closed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", "operationId": "pull-request/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1234537,7 +1243104,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1234605,7 +1243172,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1239439,11 +1248006,11 @@ }, "pull-request-converted-to-draft": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/converted-to-draft", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1239519,7 +1248086,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1239587,7 +1248154,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1244421,11 +1252988,11 @@ }, "pull-request-demilestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was removed from a milestone.", "operationId": "pull-request/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1244501,7 +1253068,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1249221,11 +1257788,11 @@ }, "pull-request-dequeued": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was removed from the merge queue.", "operationId": "pull-request/dequeued", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1249301,7 +1257868,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1249369,7 +1257936,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1253832,11 +1262399,11 @@ }, "pull-request-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", "operationId": "pull-request/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1253973,7 +1262540,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1254041,7 +1262608,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1258875,11 +1267442,11 @@ }, "pull-request-enqueued": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was added to the merge queue.", "operationId": "pull-request/enqueued", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1258955,7 +1267522,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1259023,7 +1267590,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1263468,11 +1272035,11 @@ }, "pull-request-labeled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A label was added to a pull request.", "operationId": "pull-request/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1263548,7 +1272115,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1263616,7 +1272183,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1268118,11 +1276685,11 @@ }, "pull-request-locked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1268198,7 +1276765,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1268266,7 +1276833,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1272725,11 +1281292,11 @@ }, "pull-request-milestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was added to a milestone.", "operationId": "pull-request/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1272805,7 +1281372,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1277525,11 +1286092,11 @@ }, "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was created", "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1277605,7 +1286172,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1277673,7 +1286240,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1282507,11 +1291074,11 @@ }, "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1282587,7 +1291154,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1282655,7 +1291222,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1287489,11 +1296056,11 @@ }, "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A previously closed pull request was reopened.", "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1287569,7 +1296136,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1287637,7 +1296204,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1292471,11 +1301038,11 @@ }, "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment on a pull request diff was created.", "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -1292551,7 +1301118,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1292910,7 +1301477,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1292978,7 +1301545,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1297289,11 +1305856,11 @@ }, "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment on a pull request diff was deleted.", "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -1297369,7 +1305936,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1297727,7 +1306294,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1297795,7 +1306362,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1302094,11 +1310661,11 @@ }, "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The content of a comment on a pull request diff was changed.", "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -1302192,7 +1310759,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1302550,7 +1311117,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1302618,7 +1311185,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1306922,11 +1315489,11 @@ }, "pull-request-review-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A review on a pull request was dismissed.", "operationId": "pull-request-review/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -1307002,7 +1315569,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1307070,7 +1315637,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1311591,11 +1320158,11 @@ }, "pull-request-review-edited": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The body comment on a pull request review was edited.", "operationId": "pull-request-review/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -1311688,7 +1320255,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1311756,7 +1320323,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1316150,11 +1324717,11 @@ }, "pull-request-review-request-removed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A request for review by a person or team was removed from a pull request.", "operationId": "pull-request/review-request-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1316232,7 +1324799,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1316300,7 +1324867,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1320850,7 +1329417,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1320918,7 +1329485,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1325524,11 +1334091,11 @@ }, "pull-request-review-requested": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", "operationId": "pull-request/review-requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1325606,7 +1334173,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1325674,7 +1334241,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1330220,7 +1338787,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1330288,7 +1338855,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1334871,11 +1343438,11 @@ }, "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A review on a pull request was submitted.", "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -1334951,7 +1343518,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1335019,7 +1343586,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1339537,11 +1348104,11 @@ }, "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment thread on a pull request was marked as resolved.", "operationId": "pull-request-review-thread/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -1339617,7 +1348184,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1339685,7 +1348252,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1343896,7 +1352463,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1344299,11 +1352866,11 @@ }, "pull-request-review-thread-unresolved": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A previously resolved comment thread on a pull request was marked as unresolved.", "operationId": "pull-request-review-thread/unresolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -1344379,7 +1352946,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1344447,7 +1353014,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1348644,7 +1357211,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1349045,11 +1357612,11 @@ }, "pull-request-synchronize": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", "operationId": "pull-request/synchronize", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1349131,7 +1357698,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1349199,7 +1357766,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1353659,11 +1362226,11 @@ }, "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A user was unassigned from a pull request.", "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1353835,7 +1362402,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1353903,7 +1362470,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1358364,11 +1366931,11 @@ }, "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A label was removed from a pull request.", "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1358444,7 +1367011,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1358512,7 +1367079,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1363013,11 +1371580,11 @@ }, "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1363093,7 +1371660,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1363161,7 +1371728,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1367608,7 +1376175,7 @@ "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1367689,7 +1376256,7 @@ "type": "string" }, "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) to fetch additional commits.", + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -1367821,7 +1376388,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1368009,7 +1376576,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1368913,11 +1377480,11 @@ }, "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", "description": "A package was published to a registry.", "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1368992,7 +1377559,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1369060,7 +1377627,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1371334,11 +1379901,11 @@ }, "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", "description": "A package that was previously published to a registry was updated.", "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1371413,7 +1379980,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1371481,7 +1380048,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1373497,11 +1382064,11 @@ }, "release-created": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", "operationId": "release/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1373577,7 +1382144,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1373645,7 +1382212,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1373739,7 +1382306,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -1375541,11 +1384108,11 @@ }, "release-deleted": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release, pre-release, or draft release was deleted.", "operationId": "release/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1375621,7 +1384188,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1375689,7 +1384256,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1375783,7 +1384350,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -1377585,11 +1386152,11 @@ }, "release-edited": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", "operationId": "release/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1377718,7 +1386285,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1377786,7 +1386353,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1377880,7 +1386447,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -1379682,11 +1388249,11 @@ }, "release-prereleased": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", "operationId": "release/prereleased", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1379762,7 +1388329,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1379830,7 +1388397,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1379924,7 +1388491,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -1381729,11 +1390296,11 @@ }, "release-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release, pre-release, or draft of a release was published.", "operationId": "release/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1381809,7 +1390376,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1381877,7 +1390444,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1381971,7 +1390538,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -1383773,11 +1392340,11 @@ }, "release-released": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release was published, or a pre-release was changed to a release.", "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1383853,7 +1392420,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1383921,7 +1392488,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1384015,7 +1392582,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -1385816,11 +1394383,11 @@ }, "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release or pre-release was unpublished.", "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1385896,7 +1394463,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1385964,7 +1394531,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1386058,7 +1394625,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -1387860,11 +1396427,11 @@ }, "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", "description": "A repository security advisory was published.", "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1387940,7 +1396507,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1388008,7 +1396575,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1391052,11 +1399619,11 @@ }, "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", "description": "A private vulnerability report was submitted.", "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1391132,7 +1399699,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1391200,7 +1399767,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1394244,11 +1402811,11 @@ }, "repository-archived": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A repository was archived.", "operationId": "repository/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1394324,7 +1402891,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1394392,7 +1402959,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1395869,11 +1404436,11 @@ }, "repository-created": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A repository was created.", "operationId": "repository/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1395949,7 +1404516,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1396017,7 +1404584,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1397494,11 +1406061,11 @@ }, "repository-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", "operationId": "repository/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1397574,7 +1406141,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1397642,7 +1406209,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1399119,10 +1407686,10 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -1399205,7 +1407772,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1399273,7 +1407840,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1400750,11 +1409317,11 @@ }, "repository-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "The topics, default branch, description, or homepage of a repository was changed.", "operationId": "repository/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1400882,7 +1409449,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1400950,7 +1409517,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1402428,10 +1410995,10 @@ }, "repository-import": { "post": { - "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", + "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports).", "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -1402501,7 +1411068,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1402569,7 +1411136,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1404052,11 +1412619,11 @@ }, "repository-privatized": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "The visibility of a repository was changed to `private`.", "operationId": "repository/privatized", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1404132,7 +1412699,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1404200,7 +1412767,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1405677,11 +1414244,11 @@ }, "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "The visibility of a repository was changed to `public`.", "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1405757,7 +1414324,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1405825,7 +1414392,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1407302,11 +1415869,11 @@ }, "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "The name of a repository was changed.", "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1407409,7 +1415976,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1407477,7 +1416044,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1408955,11 +1417522,11 @@ }, "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was created.", "operationId": "repository-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -1409035,7 +1417602,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1409103,7 +1417670,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1411662,7 +1420229,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1411672,7 +1420239,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1411895,11 +1420462,11 @@ }, "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was deleted.", "operationId": "repository-ruleset/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -1411975,7 +1420542,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1412043,7 +1420610,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1414602,7 +1423169,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1414612,7 +1423179,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1414835,11 +1423402,11 @@ }, "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was edited.", "operationId": "repository-ruleset/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -1414915,7 +1423482,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1414983,7 +1423550,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1417542,7 +1426109,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1417552,7 +1426119,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1418616,7 +1427183,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1418626,7 +1427193,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1419518,7 +1428085,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1419528,7 +1428095,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1420423,7 +1428990,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1420433,7 +1429000,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1420681,11 +1429248,11 @@ }, "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1420947,7 +1429514,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1421015,7 +1429582,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1422493,11 +1431060,11 @@ }, "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A previously archived repository was unarchived.", "operationId": "repository/unarchived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1422573,7 +1431140,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1422641,7 +1431208,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1424122,7 +1432689,7 @@ "description": "A repository vulnerability alert was created.", "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1424365,7 +1432932,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1424433,7 +1433000,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1425913,7 +1434480,7 @@ "description": "A repository vulnerability alert was dismissed.", "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1426165,7 +1434732,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1426233,7 +1434800,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1427713,7 +1436280,7 @@ "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1427956,7 +1436523,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1428024,7 +1436591,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1429504,7 +1438071,7 @@ "description": "A repository vulnerability alert was marked as resolved.", "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1429747,7 +1438314,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1429815,7 +1438382,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1431291,11 +1439858,11 @@ }, "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was assigned.", "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1431562,7 +1440129,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -1432258,7 +1440825,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1432326,7 +1440893,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1433802,11 +1442369,11 @@ }, "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was created.", "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1434073,7 +1442640,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -1434645,7 +1443212,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1434713,7 +1443280,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1436189,11 +1444756,11 @@ }, "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1436460,7 +1445027,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -1437032,7 +1445599,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1439046,11 +1447613,11 @@ }, "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was detected in a public repo.", "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1439317,7 +1447884,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -1439889,7 +1448456,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1439957,7 +1448524,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1441433,11 +1450000,11 @@ }, "secret-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A previously closed secret scanning alert was reopened.", "operationId": "secret-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1441704,7 +1450271,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -1442276,7 +1450843,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1442344,7 +1450911,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1443820,11 +1452387,11 @@ }, "secret-scanning-alert-resolved": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was closed.", "operationId": "secret-scanning-alert/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1444091,7 +1452658,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -1444663,7 +1453230,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1444731,7 +1453298,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1446207,11 +1454774,11 @@ }, "secret-scanning-alert-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was unassigned.", "operationId": "secret-scanning-alert/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1446478,7 +1455045,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -1447174,7 +1455741,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1447242,7 +1455809,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1448718,11 +1457285,11 @@ }, "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was validated.", "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1448989,7 +1457556,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": "string", @@ -1449561,7 +1458128,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1449629,7 +1458196,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1451105,11 +1459672,11 @@ }, "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning scan was completed.", "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -1452469,7 +1461036,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1452537,7 +1461104,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1452784,11 +1461351,11 @@ }, "security-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "A security advisory was published to the GitHub community.", "operationId": "security-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -1452864,7 +1461431,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1452932,7 +1461499,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1454613,11 +1463180,11 @@ }, "security-advisory-updated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "The metadata or description of a security advisory was changed.", "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -1454693,7 +1463260,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1454761,7 +1463328,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1456442,11 +1465009,11 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -1456522,7 +1465089,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1456590,7 +1465157,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1458270,10 +1466837,10 @@ }, "security-and-analysis": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -1458521,7 +1467088,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1458589,7 +1467156,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1462106,11 +1470673,11 @@ }, "sponsorship-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", "operationId": "sponsorship/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1462186,7 +1470753,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1462254,7 +1470821,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1464045,11 +1472612,11 @@ }, "sponsorship-created": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", "operationId": "sponsorship/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1464125,7 +1472692,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1464193,7 +1472760,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1465984,11 +1474551,11 @@ }, "sponsorship-edited": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", "operationId": "sponsorship/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1466081,7 +1474648,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1466149,7 +1474716,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1467941,11 +1476508,11 @@ }, "sponsorship-pending-cancellation": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", "operationId": "sponsorship/pending-cancellation", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1468025,7 +1476592,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1468093,7 +1476660,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1469884,11 +1478451,11 @@ }, "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1470027,7 +1478594,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1470095,7 +1478662,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1471887,11 +1480454,11 @@ }, "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1472026,7 +1480593,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1472094,7 +1480661,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1473886,11 +1482453,11 @@ }, "star-created": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "Someone starred a repository.", "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -1473966,7 +1482533,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1474034,7 +1482601,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1475516,11 +1484083,11 @@ }, "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "Someone unstarred the repository.", "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -1475596,7 +1484163,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1475664,7 +1484231,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1477145,10 +1485712,10 @@ }, "status": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -1477689,7 +1486256,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1477761,7 +1486328,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1479276,7 +1487843,7 @@ "description": "A parent issue was added to an issue.", "operationId": "sub-issues/parent-issue-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -1486016,7 +1494583,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1487499,7 +1496066,7 @@ "description": "A parent issue was removed from an issue.", "operationId": "sub-issues/parent-issue-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -1494239,7 +1502806,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1495722,7 +1504289,7 @@ "description": "A sub-issue was added to an issue.", "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -1502462,7 +1511029,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1503945,7 +1512512,7 @@ "description": "A sub-issue was removed from an issue.", "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -1510685,7 +1519252,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1512164,10 +1520731,10 @@ }, "team-add": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -1512237,7 +1520804,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1512305,7 +1520872,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1513964,11 +1522531,11 @@ }, "team-added-to-repository": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A team was granted access to a repository.", "operationId": "team/added-to-repository", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1514044,7 +1522611,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1514112,7 +1522679,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1515137,11 +1523704,11 @@ }, "team-created": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A team was created.", "operationId": "team/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1515217,7 +1523784,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1515285,7 +1523852,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1516311,11 +1524878,11 @@ }, "team-deleted": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A team was deleted.", "operationId": "team/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1516391,7 +1524958,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1516459,7 +1525026,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1517484,11 +1526051,11 @@ }, "team-edited": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "The name, description, or visibility of a team was changed.", "operationId": "team/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1517651,7 +1526218,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1517719,7 +1526286,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1518746,11 +1527313,11 @@ }, "team-removed-from-repository": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A team's access to a repository was removed.", "operationId": "team/removed-from-repository", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1518826,7 +1527393,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1518894,7 +1527461,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1519920,11 +1528487,11 @@ }, "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest//account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "Someone started watching the repository.", "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -1520000,7 +1528567,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1520068,7 +1528635,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1521544,10 +1530111,10 @@ }, "workflow-dispatch": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -1521617,7 +1530184,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1521690,7 +1530257,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1523172,11 +1531739,11 @@ }, "workflow-job-completed": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", "operationId": "workflow-job/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -1523252,7 +1531819,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1523320,7 +1531887,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1524811,7 +1533378,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-cloud@latest//actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-cloud@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -1525634,11 +1534201,11 @@ }, "workflow-job-in-progress": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run started processing on a runner.", "operationId": "workflow-job/in-progress", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -1525714,7 +1534281,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1525782,7 +1534349,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1527270,7 +1535837,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-cloud@latest//actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-cloud@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -1528128,11 +1536695,11 @@ }, "workflow-job-queued": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run was created.", "operationId": "workflow-job/queued", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -1528208,7 +1536775,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1528276,7 +1536843,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1530467,11 +1539034,11 @@ }, "workflow-job-waiting": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run was created and is waiting for approvals.", "operationId": "workflow-job/waiting", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -1530547,7 +1539114,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1530615,7 +1539182,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1532807,11 +1541374,11 @@ }, "workflow-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", "operationId": "workflow-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -1532887,7 +1541454,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1532955,7 +1541522,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1535695,11 +1544262,11 @@ }, "workflow-run-in-progress": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run started processing on a runner.", "operationId": "workflow-run/in-progress", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -1535775,7 +1544342,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1535843,7 +1544410,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1538565,11 +1547132,11 @@ }, "workflow-run-requested": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run was triggered.", "operationId": "workflow-run/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -1538645,7 +1547212,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1538713,7 +1547280,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index d0a74ad713..8bb73fb3e3 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -73,6 +73,9 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot @@ -309,20 +312,20 @@ paths: subcategory: meta externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#github-api-root + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#github-api-root "/advisories": get: summary: List global security advisories description: |- Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. - By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." tags: - security-advisories operationId: security-advisories/list-global-advisories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#list-global-security-advisories + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#list-global-security-advisories parameters: - name: ghsa_id in: query @@ -415,7 +418,7 @@ paths: description: |- If specified, only return advisories that were published on a date or date range. - For more information on the syntax of the date range, 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)." + For more information on the syntax of the date range, 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)." schema: type: string - name: updated @@ -423,14 +426,14 @@ paths: description: |- If specified, only return advisories that were updated on a date or date range. - For more information on the syntax of the date range, 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)." + For more information on the syntax of the date range, 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)." schema: type: string - name: modified description: |- If specified, only show advisories that were updated or published on a date or date range. - For more information on the syntax of the date range, 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)." + For more information on the syntax of the date range, 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)." in: query schema: type: string @@ -450,18 +453,18 @@ paths: type: string - &110 name: before - 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). + 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. For - more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: string - &111 name: after - 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). + 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. For - more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -479,7 +482,7 @@ paths: default: desc - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -865,7 +868,7 @@ paths: - subscriptions_url - type - url - type: &461 + type: &463 type: string description: The type of credit the user is receiving. enum: @@ -998,7 +1001,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &264 + schema: &266 title: Validation Error Simple description: Validation Error Simple type: object @@ -1029,9 +1032,9 @@ paths: operationId: security-advisories/get-global-advisory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &778 + - &780 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1125,15 +1128,15 @@ paths: get: summary: Get the authenticated app description: |- - Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-authenticated externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-the-authenticated-app parameters: [] responses: '200': @@ -1149,7 +1152,7 @@ paths: GitHub. type: object nullable: true - properties: &222 + properties: &224 id: description: Unique identifier of the GitHub app example: 37 @@ -1171,7 +1174,7 @@ paths: title: Enterprise description: An enterprise on GitHub. type: object - properties: &142 + properties: &144 description: description: A short description of the enterprise. type: string @@ -1213,7 +1216,7 @@ paths: avatar_url: type: string format: uri - required: &143 + required: &145 - id - node_id - name @@ -1282,7 +1285,7 @@ paths: about itself. example: 5 type: integer - required: &223 + required: &225 - id - node_id - owner @@ -1343,7 +1346,7 @@ paths: post: summary: Create a GitHub App from a manifest description: Use this endpoint to complete the handshake necessary when implementing - the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/creating-github-apps-from-a-manifest/). + the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. tags: @@ -1351,7 +1354,7 @@ paths: operationId: apps/create-from-manifest externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-github-app-from-a-manifest + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-a-github-app-from-a-manifest parameters: - name: code in: path @@ -1466,13 +1469,13 @@ paths: description: |- Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-webhook-config-for-app externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-webhook-configuration-for-an-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#get-a-webhook-configuration-for-an-app responses: '200': description: Response @@ -1497,7 +1500,7 @@ paths: type: string description: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature - headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers). + headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers). example: '"********"' insecure_ssl: &11 oneOf: @@ -1527,13 +1530,13 @@ paths: description: |- Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/update-webhook-config-for-app externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#update-a-webhook-configuration-for-an-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#update-a-webhook-configuration-for-an-app requestBody: required: true content: @@ -1571,23 +1574,23 @@ paths: description: |- Returns a list of webhook deliveries for the webhook configured for a GitHub App. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/list-webhook-deliveries externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#list-deliveries-for-an-app-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#list-deliveries-for-an-app-webhook parameters: - &17 name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 - - &361 + - &363 name: cursor 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 @@ -1596,7 +1599,7 @@ paths: required: false schema: type: string - - &362 + - &364 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1616,7 +1619,7 @@ paths: application/json: schema: type: array - items: &363 + items: &365 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1696,7 +1699,7 @@ paths: - installation_id - repository_id examples: - default: &364 + default: &366 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1728,7 +1731,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &787 + schema: &789 title: Scim Error description: Scim Error type: object @@ -1755,7 +1758,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &263 + schema: &265 title: Validation Error description: Validation Error type: object @@ -1805,13 +1808,13 @@ paths: description: |- Returns a delivery for the webhook configured for a GitHub App. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-delivery-for-an-app-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#get-a-delivery-for-an-app-webhook parameters: - &16 name: delivery_id @@ -1824,7 +1827,7 @@ paths: description: Response content: application/json: - schema: &365 + schema: &367 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1938,7 +1941,7 @@ paths: - request - response examples: - default: &366 + default: &368 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1988,13 +1991,13 @@ paths: description: |- Redeliver a delivery for the webhook configured for a GitHub App. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/redeliver-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook parameters: - *16 responses: @@ -2024,13 +2027,13 @@ paths: operationId: apps/list-installation-requests-for-authenticated-app externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installation-requests-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installation-requests-for-the-authenticated-app parameters: - *17 - &19 name: page description: The page number of the results to fetch. For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -2129,17 +2132,17 @@ paths: description: |- The permissions the installation has are included under the `permissions` key. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/list-installations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installations-for-the-authenticated-app parameters: - *17 - *19 - - &234 + - &236 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2755,13 +2758,13 @@ paths: description: |- Enables an authenticated GitHub App to find an installation's information using the installation id. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-installation-for-the-authenticated-app parameters: - &23 name: installation_id @@ -2835,15 +2838,15 @@ paths: delete: summary: Delete an installation for the authenticated app description: |- - Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation)" endpoint. + Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#suspend-an-app-installation)" endpoint. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/delete-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#delete-an-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#delete-an-installation-for-the-authenticated-app parameters: - *23 responses: @@ -2867,13 +2870,13 @@ paths: Enterprise account installations do not have access to repositories and cannot be scoped down using the `permissions` parameter. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/create-installation-access-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-an-installation-access-token-for-an-app parameters: - *23 requestBody: @@ -2934,7 +2937,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &435 + properties: &437 id: description: Unique identifier of the repository example: 42 @@ -2954,7 +2957,7 @@ paths: title: License Simple description: License Simple type: object - properties: &230 + properties: &232 key: type: string example: mit @@ -2976,7 +2979,7 @@ paths: html_url: type: string format: uri - required: &231 + required: &233 - key - name - url @@ -3385,7 +3388,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &436 + required: &438 - archive_url - assignees_url - blobs_url @@ -3621,13 +3624,13 @@ paths: description: |- Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/suspend-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#suspend-an-app-installation parameters: - *23 responses: @@ -3644,13 +3647,13 @@ paths: description: |- Removes a GitHub App installation suspension. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/unsuspend-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#unsuspend-an-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#unsuspend-an-app-installation parameters: - *23 responses: @@ -3673,7 +3676,7 @@ paths: - apps externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-authorization + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#delete-an-app-authorization parameters: - &26 name: client_id @@ -3723,7 +3726,7 @@ paths: operationId: apps/check-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#check-a-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#check-a-token parameters: - *26 requestBody: @@ -3924,7 +3927,7 @@ paths: operationId: apps/reset-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#reset-a-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#reset-a-token parameters: - *26 requestBody: @@ -3966,7 +3969,7 @@ paths: operationId: apps/delete-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#delete-an-app-token parameters: - *26 requestBody: @@ -4009,7 +4012,7 @@ paths: operationId: apps/scope-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-scoped-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-a-scoped-access-token parameters: - *26 requestBody: @@ -4156,7 +4159,7 @@ paths: operationId: apps/get-by-slug externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app parameters: - name: app_slug in: path @@ -4188,7 +4191,7 @@ paths: operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-an-assignment parameters: - &31 name: assignment_id @@ -4449,7 +4452,7 @@ paths: operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-accepted-assignments-for-an-assignment parameters: - *31 - *19 @@ -4712,7 +4715,7 @@ paths: operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-assignment-grades parameters: - *31 responses: @@ -4813,7 +4816,7 @@ paths: operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-classrooms + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-classrooms parameters: - *19 - *17 @@ -4847,7 +4850,7 @@ paths: operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-a-classroom parameters: - &35 name: classroom_id @@ -4892,7 +4895,7 @@ paths: operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-assignments-for-a-classroom parameters: - *35 - *19 @@ -4943,7 +4946,7 @@ paths: operationId: codes-of-conduct/get-all-codes-of-conduct externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct + url: https://docs.github.com/enterprise-cloud@latest/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct parameters: [] responses: '200': @@ -5050,7 +5053,7 @@ paths: operationId: codes-of-conduct/get-conduct-code externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct + url: https://docs.github.com/enterprise-cloud@latest/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct parameters: - name: key in: path @@ -5149,7 +5152,7 @@ paths: operationId: credentials/revoke externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/credentials/revoke#revoke-a-list-of-credentials + url: https://docs.github.com/enterprise-cloud@latest/rest/credentials/revoke#revoke-a-list-of-credentials requestBody: required: true content: @@ -5198,7 +5201,7 @@ paths: - emojis externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/emojis/emojis#get-emojis + url: https://docs.github.com/enterprise-cloud@latest/rest/emojis/emojis#get-emojis parameters: [] responses: '200': @@ -7111,7 +7114,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics parameters: - name: enterprise_or_org description: The slug version of the enterprise name or the login of an organization. @@ -7120,14 +7123,14 @@ paths: schema: type: string - name: date_start - 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). + 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. in: query required: false schema: type: string - name: date_end - 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). + 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. in: query required: false @@ -7447,7 +7450,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise parameters: - &41 name: enterprise @@ -7505,7 +7508,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise parameters: - *41 responses: @@ -7541,7 +7544,7 @@ paths: operationId: actions/get-actions-cache-retention-limit-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise parameters: - *41 responses: @@ -7583,7 +7586,7 @@ paths: operationId: actions/set-actions-cache-retention-limit-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise parameters: - *41 requestBody: @@ -7617,7 +7620,7 @@ paths: operationId: actions/get-actions-cache-storage-limit-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise parameters: - *41 responses: @@ -7659,7 +7662,7 @@ paths: operationId: actions/set-actions-cache-storage-limit-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise parameters: - *41 requestBody: @@ -7693,7 +7696,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise parameters: - *41 responses: @@ -7701,7 +7704,7 @@ paths: description: Response content: application/json: - schema: &265 + schema: &267 type: object properties: total_active_caches_count: @@ -7716,7 +7719,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &266 + default: &268 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7739,7 +7742,7 @@ paths: operationId: actions/list-hosted-runners-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise parameters: - *41 - *17 @@ -7909,7 +7912,7 @@ paths: - public_ip_enabled - platform examples: - default: &267 + default: &269 value: total_count: 2 runners: @@ -7967,7 +7970,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise parameters: - *41 requestBody: @@ -8088,7 +8091,7 @@ paths: operationId: actions/list-custom-images-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-custom-images-for-an-enterprise parameters: - *41 responses: @@ -8187,7 +8190,7 @@ paths: operationId: actions/get-custom-image-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners parameters: - *41 - &50 @@ -8204,7 +8207,7 @@ paths: application/json: schema: *49 examples: - default: &268 + default: &270 value: id: 1 platform: linux-x64 @@ -8230,7 +8233,7 @@ paths: operationId: actions/delete-custom-image-from-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise parameters: - *41 - *50 @@ -8254,7 +8257,7 @@ paths: operationId: actions/list-custom-image-versions-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise parameters: - *50 - *41 @@ -8325,7 +8328,7 @@ paths: operationId: actions/get-custom-image-version-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners parameters: - *41 - *50 @@ -8344,7 +8347,7 @@ paths: application/json: schema: *52 examples: - default: &269 + default: &271 value: version: 1.0.0 size_gb: 75 @@ -8366,7 +8369,7 @@ paths: operationId: actions/delete-custom-image-version-from-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise parameters: - *41 - *50 @@ -8389,7 +8392,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise parameters: - *41 responses: @@ -8465,7 +8468,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise parameters: - *41 responses: @@ -8500,7 +8503,7 @@ paths: operationId: actions/get-hosted-runners-limits-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise parameters: - *41 responses: @@ -8508,7 +8511,7 @@ paths: description: Response content: application/json: - schema: &270 + schema: &272 type: object properties: public_ips: @@ -8533,7 +8536,7 @@ paths: required: - public_ips examples: - default: &271 + default: &273 value: public_ips: current_usage: 17 @@ -8553,7 +8556,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise parameters: - *41 responses: @@ -8573,7 +8576,7 @@ paths: type: array items: *56 examples: - default: &272 + default: &274 value: id: 4-core cpu_cores: 4 @@ -8594,7 +8597,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise parameters: - *41 responses: @@ -8638,7 +8641,7 @@ paths: operationId: actions/get-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - *41 - &58 @@ -8673,7 +8676,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - *41 - *58 @@ -8758,7 +8761,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - *41 - *58 @@ -8787,7 +8790,7 @@ paths: operationId: actions/set-actions-oidc-custom-issuer-policy-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise parameters: - *41 responses: @@ -8826,7 +8829,7 @@ paths: operationId: oidc/list-oidc-custom-property-inclusions-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise parameters: - *41 responses: @@ -8881,14 +8884,14 @@ paths: operationId: oidc/create-oidc-custom-property-inclusion-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise parameters: - *41 requestBody: required: true content: application/json: - schema: &273 + schema: &275 title: Actions OIDC Custom Property Inclusion Input description: Input for creating an OIDC custom property inclusion type: object @@ -8933,7 +8936,7 @@ paths: operationId: oidc/delete-oidc-custom-property-inclusion-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise parameters: - *41 - name: custom_property_name @@ -8967,7 +8970,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise parameters: - *41 responses: @@ -8999,7 +9002,7 @@ paths: - all - local_only - selected - selected_actions_url: &275 + selected_actions_url: &277 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -9033,7 +9036,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise parameters: - *41 responses: @@ -9071,7 +9074,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise parameters: - *41 responses: @@ -9079,7 +9082,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &277 + schema: &279 type: object properties: days: @@ -9097,7 +9100,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &788 + '401': &790 description: Authorization failure '404': *6 x-github: @@ -9113,7 +9116,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise parameters: - *41 responses: @@ -9125,7 +9128,7 @@ paths: required: true content: application/json: - schema: &278 + schema: &280 type: object properties: days: @@ -9152,7 +9155,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise parameters: - *41 responses: @@ -9174,7 +9177,7 @@ paths: required: - approval_policy examples: - default: &279 + default: &281 value: approval_policy: first_time_contributors '404': *6 @@ -9191,7 +9194,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise parameters: - *41 responses: @@ -9224,7 +9227,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise parameters: - *41 responses: @@ -9232,7 +9235,7 @@ paths: description: Response content: application/json: - schema: &280 + schema: &282 type: object required: - run_workflows_from_fork_pull_requests @@ -9279,14 +9282,14 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise parameters: - *41 requestBody: required: true content: application/json: - schema: &281 + schema: &283 type: object required: - run_workflows_from_fork_pull_requests @@ -9332,7 +9335,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise parameters: - *41 - *17 @@ -9443,7 +9446,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise parameters: - *41 responses: @@ -9487,7 +9490,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - &66 @@ -9516,7 +9519,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - *66 @@ -9540,7 +9543,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise parameters: - *41 responses: @@ -9592,7 +9595,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise parameters: - *41 responses: @@ -9620,7 +9623,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise parameters: - *41 responses: @@ -9656,7 +9659,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise parameters: - *41 responses: @@ -9693,7 +9696,7 @@ paths: description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: @@ -9701,7 +9704,7 @@ paths: operationId: actions/get-github-actions-default-workflow-permissions-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise parameters: - *41 responses: @@ -9709,7 +9712,7 @@ paths: description: Success response content: application/json: - schema: &284 + schema: &286 type: object properties: default_workflow_permissions: &69 @@ -9742,7 +9745,7 @@ paths: description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets whether GitHub Actions can submit approving pull request reviews. For more information, see - "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: @@ -9750,14 +9753,14 @@ paths: operationId: actions/set-github-actions-default-workflow-permissions-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise parameters: - *41 requestBody: required: true content: application/json: - schema: &285 + schema: &287 type: object properties: default_workflow_permissions: *69 @@ -9784,7 +9787,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise parameters: - *41 - *17 @@ -9914,7 +9917,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 requestBody: @@ -10021,7 +10024,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - &74 @@ -10055,7 +10058,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - *74 @@ -10143,7 +10146,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - *41 - *74 @@ -10167,7 +10170,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - *74 @@ -10207,7 +10210,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - *74 @@ -10253,7 +10256,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - *74 @@ -10277,7 +10280,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - *74 @@ -10302,7 +10305,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - *74 @@ -10439,7 +10442,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - *74 @@ -10484,7 +10487,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - *41 - *74 @@ -10514,7 +10517,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - *41 - *74 @@ -10539,7 +10542,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise parameters: - name: name description: The name of a self-hosted runner. @@ -10583,7 +10586,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise parameters: - *41 responses: @@ -10593,7 +10596,7 @@ paths: application/json: schema: type: array - items: &289 + items: &291 title: Runner Application description: Runner Application type: object @@ -10618,7 +10621,7 @@ paths: - download_url - filename examples: - default: &290 + default: &292 value: - os: osx architecture: x64 @@ -10657,7 +10660,7 @@ paths: operationId: actions/generate-runner-jitconfig-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise parameters: - *41 requestBody: @@ -10702,7 +10705,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &291 + '201': &293 description: Response content: application/json: @@ -10771,7 +10774,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise parameters: - *41 responses: @@ -10817,7 +10820,7 @@ paths: - token - expires_at examples: - default: &292 + default: &294 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10847,7 +10850,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise parameters: - *41 responses: @@ -10857,7 +10860,7 @@ paths: application/json: schema: *81 examples: - default: &293 + default: &295 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10878,7 +10881,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *41 - *77 @@ -10889,7 +10892,7 @@ paths: application/json: schema: *78 examples: - default: &294 + default: &296 value: id: 23 name: MBP @@ -10926,7 +10929,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *41 - *77 @@ -10951,7 +10954,7 @@ paths: operationId: enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - *77 @@ -11005,7 +11008,7 @@ paths: operationId: enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - *41 - *77 @@ -11052,7 +11055,7 @@ paths: operationId: enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - *77 @@ -11100,12 +11103,12 @@ paths: operationId: enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - *77 responses: - '200': &295 + '200': &297 description: Response content: application/json: @@ -11157,11 +11160,11 @@ paths: operationId: enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - *77 - - &296 + - &298 name: name description: The name of a self-hosted runner's custom label. in: path @@ -11186,7 +11189,7 @@ paths: operationId: announcement-banners/get-announcement-banner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise parameters: - *41 responses: @@ -11204,7 +11207,7 @@ paths: type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic - writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true expires_at: &85 @@ -11247,12 +11250,12 @@ paths: operationId: announcement-banners/set-announcement-banner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise requestBody: required: true content: application/json: - schema: &303 + schema: &305 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -11287,7 +11290,7 @@ paths: operationId: announcement-banners/remove-announcement-banner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise parameters: - *41 responses: @@ -11310,7 +11313,7 @@ paths: operationId: enterprise-apps/installable-organizations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed parameters: - *41 - *17 @@ -11366,7 +11369,7 @@ paths: operationId: enterprise-apps/installable-organization-accessible-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *41 - &89 @@ -11434,7 +11437,7 @@ paths: operationId: enterprise-apps/organization-installations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - *41 - *89 @@ -11529,7 +11532,7 @@ paths: operationId: enterprise-apps/create-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - *41 - *89 @@ -11612,7 +11615,7 @@ paths: operationId: enterprise-apps/delete-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - *41 - *89 @@ -11640,7 +11643,7 @@ paths: operationId: enterprise-apps/organization-installation-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - *41 - *89 @@ -11681,7 +11684,7 @@ paths: operationId: enterprise-apps/change-installation-repository-access-selection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - *41 - *89 @@ -11742,7 +11745,7 @@ paths: operationId: enterprise-apps/grant-repository-access-to-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *41 - *89 @@ -11803,7 +11806,7 @@ paths: operationId: enterprise-apps/remove-repository-access-to-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *41 - *89 @@ -11874,7 +11877,7 @@ paths: description: |- Gets the audit log for an enterprise. - This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators)." The authenticated user must be an enterprise admin to use this endpoint. @@ -11883,17 +11886,17 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise parameters: - *41 - name: phrase 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). + 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). in: query required: false schema: type: string - - &306 + - &308 name: include description: |- The event types to include: @@ -11911,23 +11914,23 @@ paths: - web - git - all - - &307 + - &309 name: after - 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). + 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. in: query required: false schema: type: string - - &308 + - &310 name: before - 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). + 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. in: query required: false schema: type: string - - &309 + - &311 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11949,7 +11952,7 @@ paths: application/json: schema: type: array - items: &310 + items: &312 type: object properties: "@timestamp": @@ -12071,7 +12074,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &311 + default: &313 value: - "@timestamp": 1606929874512 action: team.add_member @@ -12112,7 +12115,7 @@ paths: operationId: enterprise-admin/get-audit-log-stream-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets parameters: - *41 responses: @@ -12156,7 +12159,7 @@ paths: operationId: enterprise-admin/get-audit-log-streams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise parameters: - *41 responses: @@ -12222,7 +12225,7 @@ paths: operationId: enterprise-admin/create-audit-log-stream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *41 requestBody: @@ -12530,7 +12533,7 @@ paths: operationId: enterprise-admin/get-one-audit-log-stream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - *41 - &94 @@ -12564,7 +12567,7 @@ paths: operationId: enterprise-admin/update-audit-log-stream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *41 - *94 @@ -12642,7 +12645,7 @@ paths: operationId: enterprise-admin/delete-audit-log-stream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *41 - *94 @@ -12664,7 +12667,7 @@ paths: operationId: enterprise-admin/list-push-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -12737,7 +12740,7 @@ paths: application/json: schema: type: array - items: &312 + items: &314 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12898,7 +12901,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &313 + default: &315 value: - id: 21 number: 42 @@ -12981,7 +12984,7 @@ paths: operationId: secret-scanning/list-enterprise-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -13003,7 +13006,7 @@ paths: application/json: schema: type: array - items: &315 + items: &317 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -13128,7 +13131,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &316 + default: &318 value: - id: 21 number: 42 @@ -13200,7 +13203,7 @@ paths: get: summary: List code scanning alerts for an enterprise description: |- - Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be a member of the enterprise to use this endpoint. @@ -13210,10 +13213,10 @@ paths: operationId: code-scanning/list-alerts-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &321 + - &323 name: tool_name 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`, @@ -13223,7 +13226,7 @@ paths: schema: &113 type: string description: The name of the tool used to generate the code scanning analysis. - - &322 + - &324 name: tool_guid 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 @@ -13246,7 +13249,7 @@ paths: be returned. in: query required: false - schema: &323 + schema: &325 type: string description: State of a code scanning alert. enum: @@ -13279,7 +13282,7 @@ paths: application/json: schema: type: array - items: &324 + items: &326 type: object properties: number: &131 @@ -13308,7 +13311,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &552 + instances_url: &554 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13343,7 +13346,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &553 + dismissed_reason: &555 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -13352,13 +13355,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &554 + dismissed_comment: &556 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &555 + rule: &557 type: object properties: id: @@ -13411,7 +13414,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &556 + tool: &558 type: object properties: name: *113 @@ -13421,26 +13424,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *114 - most_recent_instance: &557 + most_recent_instance: &559 type: object properties: - ref: &550 + ref: &552 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &567 + analysis_key: &569 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &568 + environment: &570 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &569 + category: &571 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13460,7 +13463,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &570 + location: &572 type: object description: Describe a region within a file for the alert. properties: @@ -13481,7 +13484,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &571 + items: &573 type: string description: A classification of the file. For example to identify it as generated. @@ -13495,7 +13498,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &349 + properties: &142 id: type: integer format: int64 @@ -13722,7 +13725,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &350 + required: &143 - archive_url - assignees_url - blobs_url @@ -13794,7 +13797,7 @@ paths: - most_recent_instance - repository examples: - default: &325 + default: &327 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -14025,7 +14028,7 @@ paths: headers: Link: *47 '404': *6 - '503': &198 + '503': &200 description: Service unavailable content: application/json: @@ -14058,13 +14061,13 @@ paths: operationId: code-security/get-configurations-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - *41 - name: per_page in: query description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." required: false schema: type: integer @@ -14395,7 +14398,7 @@ paths: operationId: code-security/create-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise parameters: - *41 requestBody: @@ -14669,7 +14672,7 @@ paths: operationId: code-security/get-default-configurations-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise parameters: - *41 responses: @@ -14677,7 +14680,7 @@ paths: description: Response content: application/json: - schema: &327 + schema: &329 type: array description: A list of default code security configurations items: @@ -14693,7 +14696,7 @@ paths: default configuration: *116 examples: - default: &328 + default: &330 value: - default_for_new_repos: public configuration: @@ -14774,7 +14777,7 @@ paths: operationId: code-security/get-single-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *41 - &118 @@ -14813,7 +14816,7 @@ paths: operationId: code-security/update-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *41 - *118 @@ -15019,7 +15022,7 @@ paths: operationId: code-security/delete-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *41 - *118 @@ -15051,7 +15054,7 @@ paths: operationId: code-security/attach-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *41 - *118 @@ -15103,7 +15106,7 @@ paths: operationId: code-security/set-configuration-as-default-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - *41 - *118 @@ -15151,7 +15154,7 @@ paths: default: value: default_for_new_repos: all - configuration: &326 + configuration: &328 value: id: 1325 target_type: organization @@ -15210,13 +15213,13 @@ paths: operationId: code-security/get-repositories-for-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *41 - *118 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -15241,7 +15244,7 @@ paths: application/json: schema: type: array - items: &329 + items: &331 type: object description: Repositories associated with a code security configuration and attachment status @@ -15265,7 +15268,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &330 + repository: &332 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15345,7 +15348,7 @@ paths: summary: Get code security and analysis features for an enterprise description: |- > [!WARNING] - > **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + > **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Gets code security and analysis settings for the specified enterprise. @@ -15357,7 +15360,7 @@ paths: operationId: secret-scanning/get-security-analysis-settings-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise parameters: - *41 responses: @@ -15443,7 +15446,7 @@ paths: summary: Update code security and analysis features for an enterprise description: |- > [!WARNING] - > **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + > **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. @@ -15455,7 +15458,7 @@ paths: operationId: secret-scanning/patch-security-analysis-settings-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise parameters: - *41 requestBody: @@ -15469,31 +15472,31 @@ paths: type: boolean description: Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub - Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security)." advanced_security_enabled_new_user_namespace_repos: type: boolean description: Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see - "[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + "[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security)." dependabot_alerts_enabled_for_new_repositories: type: boolean description: Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot - alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." secret_scanning_enabled_for_new_repositories: type: boolean description: Whether secret scanning is automatically enabled for - new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." + new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting - pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." secret_scanning_push_protection_custom_link: type: string nullable: true description: |- - The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." To disable this functionality, set this field to `null`. secret_scanning_non_provider_patterns_enabled_for_new_repositories: type: boolean @@ -15539,7 +15542,7 @@ paths: operationId: enterprise-admin/get-consumed-licenses externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#list-enterprise-consumed-licenses + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#list-enterprise-consumed-licenses parameters: - *41 - *17 @@ -15694,7 +15697,7 @@ paths: For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). + see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data). Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -15704,13 +15707,13 @@ paths: operationId: copilot/list-copilot-seats-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise parameters: - *41 - *19 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -15730,7 +15733,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &149 + items: &151 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -15754,7 +15757,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &317 + - &319 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15829,7 +15832,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &401 + properties: &403 id: description: Unique identifier of the team type: integer @@ -15901,7 +15904,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &402 + required: &404 - id - node_id - url @@ -15927,7 +15930,7 @@ paths: - slug - parent - type - - &148 + - &150 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -16037,7 +16040,7 @@ paths: - created_at additionalProperties: false examples: - default: &150 + default: &152 value: total_seats: 2 seats: @@ -16136,7 +16139,7 @@ paths: operationId: copilot/add-copilot-seats-for-enterprise-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise parameters: - *41 requestBody: @@ -16212,7 +16215,7 @@ paths: operationId: copilot/cancel-copilot-seats-for-enterprise-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise parameters: - *41 requestBody: @@ -16302,7 +16305,7 @@ paths: operationId: copilot/add-copilot-seats-for-enterprise-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise parameters: - *41 requestBody: @@ -16378,7 +16381,7 @@ paths: operationId: copilot/cancel-copilot-seats-for-enterprise-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise parameters: - *41 requestBody: @@ -16445,7 +16448,7 @@ paths: Gets information about an enterprise's Copilot content exclusion path rules. To configure these settings, go to the enterprise's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise)." + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise)." Enterprise owners can view details about Copilot content exclusion rules for the enterprise. @@ -16459,7 +16462,7 @@ paths: operationId: copilot/copilot-content-exclusion-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-enterprise parameters: - *41 responses: @@ -16500,7 +16503,7 @@ paths: Sets Copilot content exclusion path rules for an enterprise. To configure these settings, go to the enterprise's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise)." + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise)." Enterprise owners can set Copilot content exclusion rules for the enterprise. @@ -16514,7 +16517,7 @@ paths: operationId: copilot/set-copilot-content-exclusion-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-enterprise parameters: - *41 requestBody: @@ -16574,7 +16577,7 @@ paths: '401': *25 '403': *29 '404': *6 - '413': &333 + '413': &335 description: Payload Too Large content: application/json: @@ -16601,7 +16604,7 @@ paths: operationId: copilot/get-copilot-custom-agents-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#get-custom-agents-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#get-custom-agents-for-an-enterprise parameters: - *41 - *17 @@ -16687,7 +16690,7 @@ paths: operationId: copilot/get-copilot-custom-agents-source-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#get-the-source-organization-for-custom-agents-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#get-the-source-organization-for-custom-agents-in-an-enterprise parameters: - *41 responses: @@ -16766,7 +16769,7 @@ paths: operationId: copilot/set-copilot-custom-agents-source-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#set-the-source-organization-for-custom-agents-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#set-the-source-organization-for-custom-agents-in-an-enterprise parameters: - *41 requestBody: @@ -16921,7 +16924,7 @@ paths: operationId: copilot/delete-copilot-custom-agents-source-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#delete-the-custom-agents-source-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#delete-the-custom-agents-source-for-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -16962,7 +16965,7 @@ paths: operationId: copilot/copilot-metrics-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise parameters: - *41 - name: since @@ -16984,7 +16987,7 @@ paths: - *19 - name: per_page description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -16996,7 +16999,7 @@ paths: application/json: schema: type: array - items: &211 + items: &213 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -17303,7 +17306,7 @@ paths: - date additionalProperties: true examples: - default: &212 + default: &214 value: - date: '2024-06-24' total_active_users: 24 @@ -17405,7 +17408,7 @@ paths: '500': *40 '403': *29 '404': *6 - '422': &213 + '422': &215 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -17432,7 +17435,7 @@ paths: operationId: copilot/copilot-enterprise-one-day-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day parameters: - *41 - &125 @@ -17500,7 +17503,7 @@ paths: operationId: copilot/copilot-enterprise-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics parameters: - *41 responses: @@ -17567,7 +17570,7 @@ paths: operationId: copilot/copilot-users-one-day-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day parameters: - *41 - *125 @@ -17603,7 +17606,7 @@ paths: operationId: copilot/copilot-users-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics parameters: - *41 responses: @@ -17640,7 +17643,7 @@ paths: operationId: copilot/set-enterprise-coding-agent-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise parameters: - *41 requestBody: @@ -17694,7 +17697,7 @@ paths: operationId: copilot/add-organizations-to-enterprise-coding-agent-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy parameters: - *41 requestBody: @@ -17769,7 +17772,7 @@ paths: operationId: copilot/remove-organizations-from-enterprise-coding-agent-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy parameters: - *41 requestBody: @@ -17835,7 +17838,7 @@ paths: The authenticated user must be a member of the enterprise to use this endpoint. - Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. tags: @@ -17843,10 +17846,10 @@ paths: operationId: dependabot/list-alerts-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &338 + - &340 name: classification in: query description: |- @@ -17855,7 +17858,7 @@ paths: Can be: `malware`, `general` schema: type: string - - &339 + - &341 name: state in: query description: |- @@ -17864,7 +17867,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &340 + - &342 name: severity in: query description: |- @@ -17873,7 +17876,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &341 + - &343 name: ecosystem in: query description: |- @@ -17882,14 +17885,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &342 + - &344 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &343 + - &345 name: epss_percentage in: query description: |- @@ -17901,7 +17904,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &614 + - &616 name: has in: query description: |- @@ -17915,7 +17918,7 @@ paths: type: string enum: - patch - - &344 + - &346 name: assignee in: query description: |- @@ -17924,7 +17927,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &345 + - &347 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -17934,7 +17937,7 @@ paths: enum: - development - runtime - - &346 + - &348 name: sort in: query description: |- @@ -17960,7 +17963,7 @@ paths: application/json: schema: type: array - items: &347 + items: &349 type: object description: A Dependabot alert. properties: @@ -18024,7 +18027,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &615 + security_advisory: &617 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -18263,14 +18266,14 @@ paths: nullable: true maxLength: 280 fixed_at: *141 - auto_dismissed_at: &616 + auto_dismissed_at: &618 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &617 + dismissal_request: &619 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -18332,7 +18335,7 @@ paths: - repository additionalProperties: false examples: - default: &348 + default: &350 value: - number: 2 state: dismissed @@ -18680,6 +18683,266 @@ paths: previews: [] category: dependabot subcategory: alerts + "/enterprises/{enterprise}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an enterprise + description: |- + Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise + parameters: + - *41 + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: &351 + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able + to access in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + title: Simple Repository + description: A GitHub repository. + type: object + properties: *142 + required: *143 + nullable: true + additionalProperties: false + examples: + default: &352 + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an enterprise + description: |- + Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise. + + The authenticated user must be an enterprise owner to use this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access + "/enterprises/{enterprise}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot in an enterprise + description: |- + Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + The authenticated user must be an enterprise owner to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: dependabot + subcategory: repository-access "/enterprises/{enterprise}/dismissal-requests/secret-scanning": get: summary: List alert dismissal requests for secret scanning for an enterprise @@ -18693,7 +18956,7 @@ paths: operationId: secret-scanning/list-enterprise-dismissal-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18705,7 +18968,7 @@ paths: - *105 - *106 - *107 - - &352 + - &354 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -18731,7 +18994,7 @@ paths: application/json: schema: type: array - items: &354 + items: &356 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -18852,7 +19115,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &355 + default: &357 value: - id: 21 number: 42 @@ -18935,7 +19198,7 @@ paths: operationId: enterprise-admin/list-enterprise-roles externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise parameters: - *41 responses: @@ -18953,7 +19216,7 @@ paths: roles: type: array description: The list of enterprise roles available to the enterprise. - items: &147 + items: &149 title: Enterprise Role description: Enterprise custom roles type: object @@ -18987,8 +19250,8 @@ paths: title: Enterprise description: An enterprise on GitHub. type: object - properties: *142 - required: *143 + properties: *144 + required: *145 nullable: true created_at: description: The date and time the role was created. @@ -19078,10 +19341,10 @@ paths: operationId: enterprise-admin/revoke-all-enterprise-roles-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team parameters: - *41 - - &144 + - &146 name: team_slug description: The slug of the enterprise team name. in: path @@ -19121,11 +19384,11 @@ paths: operationId: enterprise-admin/assign-team-to-enterprise-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team parameters: - *41 - - *144 - - &145 + - *146 + - &147 name: role_id description: The unique identifier of the role. in: path @@ -19164,11 +19427,11 @@ paths: operationId: enterprise-admin/revoke-enterprise-role-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team parameters: - *41 - - *144 - - *145 + - *146 + - *147 responses: '204': description: Response @@ -19199,10 +19462,10 @@ paths: operationId: enterprise-admin/remove-all-enterprise-roles-from-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user parameters: - *41 - - &146 + - &148 name: username description: The handle for the GitHub user account. in: path @@ -19239,11 +19502,11 @@ paths: operationId: enterprise-admin/assign-enterprise-role-to-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user parameters: - *41 - - *146 - - *145 + - *148 + - *147 responses: '204': description: Response @@ -19273,11 +19536,11 @@ paths: operationId: enterprise-admin/remove-enterprise-user-role-assignment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment parameters: - *41 - - *146 - - *145 + - *148 + - *147 responses: '204': description: Response @@ -19308,16 +19571,16 @@ paths: operationId: enterprise-admin/get-enterprise-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-an-enterprise-role + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#get-an-enterprise-role parameters: - *41 - - *145 + - *147 responses: '200': description: Response content: application/json: - schema: *147 + schema: *149 examples: default: value: @@ -19368,10 +19631,10 @@ paths: operationId: enterprise-admin/list-enterprise-role-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role parameters: - *41 - - *145 + - *147 - *17 - *19 responses: @@ -19381,9 +19644,9 @@ paths: application/json: schema: type: array - items: *148 + items: *150 examples: - default: &214 + default: &216 value: - id: 1 name: Justice League @@ -19419,10 +19682,10 @@ paths: operationId: enterprise-admin/list-enterprise-role-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role parameters: - *41 - - *145 + - *147 - *17 - *19 responses: @@ -19454,7 +19717,7 @@ paths: description: Enterprise Team the user has gotten the role through type: array - items: *148 + items: *150 examples: default: value: @@ -19530,13 +19793,13 @@ paths: description: |- Enables an authenticated GitHub App to find its installation on a particular enterprise. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-enterprise-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app parameters: - *41 responses: @@ -19546,7 +19809,7 @@ paths: application/json: schema: *22 examples: - default: &378 + default: &380 value: id: 1 account: @@ -19612,7 +19875,7 @@ paths: operationId: enterprise-admin/get-license-sync-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-a-license-sync-status + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-a-license-sync-status parameters: - *41 responses: @@ -19684,10 +19947,10 @@ paths: operationId: copilot/get-copilot-seat-details-for-enterprise-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - *41 - - *146 + - *148 responses: '200': description: The user's GitHub Copilot seat details, including usage. @@ -19703,9 +19966,9 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *149 + items: *151 examples: - default: *150 + default: *152 '500': *40 '401': *25 '403': *29 @@ -19728,7 +19991,7 @@ paths: operationId: hosted-compute/list-network-configurations-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise parameters: - *41 - *17 @@ -19748,7 +20011,7 @@ paths: type: integer network_configurations: type: array - items: &151 + items: &153 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -19800,7 +20063,7 @@ paths: - name - created_on examples: - default: &466 + default: &468 value: total_count: 2 network_configurations: @@ -19834,7 +20097,7 @@ paths: operationId: hosted-compute/create-network-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 requestBody: @@ -19892,9 +20155,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *153 examples: - default: &152 + default: &154 value: id: 123456789ABCDEF name: My network configuration @@ -19918,10 +20181,10 @@ paths: operationId: hosted-compute/get-network-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - &153 + - &155 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -19933,9 +20196,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *153 examples: - default: *152 + default: *154 headers: Link: *47 x-github: @@ -19952,10 +20215,10 @@ paths: operationId: hosted-compute/update-network-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - *153 + - *155 requestBody: required: true content: @@ -20008,9 +20271,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *153 examples: - default: *152 + default: *154 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20025,10 +20288,10 @@ paths: operationId: hosted-compute/delete-network-configuration-from-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - *41 - - *153 + - *155 responses: '204': description: Response @@ -20048,10 +20311,10 @@ paths: operationId: hosted-compute/get-network-settings-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &467 + - &469 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -20063,7 +20326,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &470 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -20097,7 +20360,7 @@ paths: - subnet_id - region examples: - default: &469 + default: &471 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -20126,7 +20389,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise parameters: - *41 responses: @@ -20136,7 +20399,7 @@ paths: application/json: schema: type: array - items: &154 + items: &156 title: Custom Property for Organization description: Custom property defined for an organization allOf: @@ -20204,7 +20467,7 @@ paths: - property_name - value_type examples: - default: &155 + default: &157 value: - property_name: environment url: https://api.github.com/enterprises/github/org-properties/schema/environment @@ -20250,7 +20513,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise parameters: - *41 requestBody: @@ -20264,7 +20527,7 @@ paths: type: array description: The array of organization custom properties to create or update. - items: *154 + items: *156 minItems: 1 maxItems: 100 required: @@ -20297,9 +20560,9 @@ paths: application/json: schema: type: array - items: *154 + items: *156 examples: - default: *155 + default: *157 '403': *29 '404': *6 '422': *7 @@ -20323,10 +20586,10 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise parameters: - *41 - - &156 + - &158 name: custom_property_name description: The custom property name in: path @@ -20338,9 +20601,9 @@ paths: description: Response content: application/json: - schema: *154 + schema: *156 examples: - default: &157 + default: &159 value: property_name: environment url: https://api.github.com/enterprises/github/org-properties/schema/environment @@ -20374,10 +20637,10 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise parameters: - *41 - - *156 + - *158 requestBody: required: true content: @@ -20446,9 +20709,9 @@ paths: description: Response content: application/json: - schema: *154 + schema: *156 examples: - default: *157 + default: *159 '403': *29 '404': *6 '422': *7 @@ -20471,10 +20734,10 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise parameters: - *41 - - *156 + - *158 responses: '204': *130 '403': *29 @@ -20500,7 +20763,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise parameters: - *41 - *17 @@ -20525,7 +20788,7 @@ paths: example: Hello-World properties: type: array - items: &158 + items: &160 title: Custom Property Value description: Custom property name and associated value type: object @@ -20586,7 +20849,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise parameters: - *41 requestBody: @@ -20608,7 +20871,7 @@ paths: type: array description: List of custom property names and associated values to apply to the organizations. - items: *158 + items: *160 required: - organization_logins - properties @@ -20648,7 +20911,7 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-get-enterprise-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise parameters: - *41 responses: @@ -20658,7 +20921,7 @@ paths: application/json: schema: type: array - items: &159 + items: &161 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -20726,7 +20989,7 @@ paths: - property_name - value_type examples: - default: &160 + default: &162 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -20771,7 +21034,7 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise parameters: - *41 requestBody: @@ -20784,7 +21047,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *159 + items: *161 minItems: 1 maxItems: 100 required: @@ -20814,9 +21077,9 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *160 + default: *162 '403': *29 '404': *6 x-github: @@ -20836,19 +21099,19 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-promote-definition-to-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *41 - *89 - - *156 + - *158 responses: '200': description: Response content: application/json: - schema: *159 + schema: *161 examples: - default: &161 + default: &163 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -20878,18 +21141,18 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-get-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *41 - - *156 + - *158 responses: '200': description: Response content: application/json: - schema: *159 + schema: *161 examples: - default: *161 + default: *163 '403': *29 '404': *6 x-github: @@ -20908,15 +21171,15 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - *41 - - *156 + - *158 requestBody: required: true content: application/json: - schema: &434 + schema: &436 title: Custom Property Set Payload description: Custom property set payload type: object @@ -20982,9 +21245,9 @@ paths: description: Response content: application/json: - schema: *159 + schema: *161 examples: - default: *161 + default: *163 '403': *29 '404': *6 x-github: @@ -21003,10 +21266,10 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-delete-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *41 - - *156 + - *158 responses: '204': *130 '403': *29 @@ -21025,7 +21288,7 @@ paths: operationId: repos/create-enterprise-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset parameters: - *41 requestBody: @@ -21048,7 +21311,7 @@ paths: - push - repository default: branch - enforcement: &170 + enforcement: &172 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -21061,7 +21324,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &171 + items: &173 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -21102,7 +21365,7 @@ paths: - pull_request - exempt default: always - conditions: &195 + conditions: &197 title: Enterprise ruleset conditions type: object description: |- @@ -21115,7 +21378,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &162 + - &164 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -21141,7 +21404,7 @@ paths: type: string required: - organization_name - - &165 + - &167 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -21170,7 +21433,7 @@ paths: is prevented. required: - repository_name - - &164 + - &166 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -21198,8 +21461,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *162 - - &167 + - *164 + - &169 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -21212,7 +21475,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &163 + items: &165 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -21243,16 +21506,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *163 + items: *165 required: - repository_property - - *164 + - *166 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &166 + - &168 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -21269,22 +21532,22 @@ paths: type: integer required: - organization_id - - *165 - - *164 + - *167 + - *166 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: + - *168 + - *169 - *166 - - *167 - - *164 - type: object title: organization_property_and_repository_name description: Conditions to target organizations by property and all repositories allOf: - - &169 + - &171 title: Repository ruleset conditions for organization properties type: object description: Parameters for a organization property condition @@ -21297,7 +21560,7 @@ paths: description: The organization properties and values to include. All of these properties must match for the condition to pass. - items: &168 + items: &170 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a organization @@ -21321,28 +21584,28 @@ paths: description: The organization properties and values to exclude. The condition will not pass if any of these properties match. - items: *168 + items: *170 required: - organization_property - - *165 - - *164 + - *167 + - *166 - type: object title: organization_property_and_repository_property description: Conditions to target organizations by property and repositories by property allOf: + - *171 - *169 - - *167 - - *164 + - *166 rules: type: array description: An array of rules within the ruleset. - items: &196 + items: &198 title: Repository Rule type: object description: A repository rule. oneOf: - - &172 + - &174 title: creation description: Only allow users with bypass permission to create matching refs. @@ -21354,7 +21617,7 @@ paths: type: string enum: - creation - - &173 + - &175 title: update description: Only allow users with bypass permission to update matching refs. @@ -21375,7 +21638,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &174 + - &176 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -21387,7 +21650,7 @@ paths: type: string enum: - deletion - - &175 + - &177 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -21399,7 +21662,7 @@ paths: type: string enum: - required_linear_history - - &176 + - &178 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -21423,7 +21686,7 @@ paths: type: string required: - required_deployment_environments - - &177 + - &179 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -21435,7 +21698,7 @@ paths: type: string enum: - required_signatures - - &178 + - &180 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -21538,7 +21801,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &179 + - &181 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -21585,7 +21848,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &180 + - &182 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -21597,7 +21860,7 @@ paths: type: string enum: - non_fast_forward - - &181 + - &183 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -21634,7 +21897,7 @@ paths: required: - operator - pattern - - &182 + - &184 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -21671,7 +21934,7 @@ paths: required: - operator - pattern - - &183 + - &185 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -21708,7 +21971,7 @@ paths: required: - operator - pattern - - &184 + - &186 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -21745,7 +22008,7 @@ paths: required: - operator - pattern - - &185 + - &187 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -21782,7 +22045,7 @@ paths: required: - operator - pattern - - &186 + - &188 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -21806,7 +22069,7 @@ paths: type: string required: - restricted_file_paths - - &187 + - &189 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -21830,7 +22093,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &188 + - &190 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -21853,7 +22116,7 @@ paths: type: string required: - restricted_file_extensions - - &189 + - &191 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -21877,7 +22140,7 @@ paths: maximum: 100 required: - max_file_size - - &190 + - &192 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -21926,7 +22189,7 @@ paths: - repository_id required: - workflows - - &191 + - &193 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -21958,7 +22221,7 @@ paths: description: The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity - levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." enum: - none - errors @@ -21970,7 +22233,7 @@ paths: scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code - scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." enum: - none - critical @@ -21986,7 +22249,7 @@ paths: - tool required: - code_scanning_tools - - &192 + - &194 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review @@ -22036,7 +22299,7 @@ paths: description: Response content: application/json: - schema: &193 + schema: &195 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -22071,11 +22334,11 @@ paths: source: type: string description: The name of the source - enforcement: *170 + enforcement: *172 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *171 + items: *173 current_user_can_bypass: type: string description: |- @@ -22107,8 +22370,8 @@ paths: conditions: nullable: true anyOf: - - *164 - - &440 + - *166 + - &442 title: Organization ruleset conditions type: object description: |- @@ -22122,14 +22385,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *164 - - *165 + - *166 + - *167 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *164 + - *166 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -22151,20 +22414,20 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *164 - - *167 + - *166 + - *169 rules: type: array - items: &744 + items: &746 title: Repository Rule type: object description: A repository rule. oneOf: - - *172 - - *173 - *174 - *175 - - &742 + - *176 + - *177 + - &744 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -22242,8 +22505,6 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *176 - - *177 - *178 - *179 - *180 @@ -22259,6 +22520,8 @@ paths: - *190 - *191 - *192 + - *193 + - *194 created_at: type: string format: date-time @@ -22266,7 +22529,7 @@ paths: type: string format: date-time examples: - default: &194 + default: &196 value: id: 21 name: super cool ruleset @@ -22311,7 +22574,7 @@ paths: operationId: repos/get-enterprise-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset parameters: - *41 - name: ruleset_id @@ -22325,9 +22588,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *195 examples: - default: *194 + default: *196 '404': *6 '500': *40 x-github: @@ -22343,7 +22606,7 @@ paths: operationId: repos/update-enterprise-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset parameters: - *41 - name: ruleset_id @@ -22371,16 +22634,16 @@ paths: - tag - push - repository - enforcement: *170 + enforcement: *172 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *171 - conditions: *195 + items: *173 + conditions: *197 rules: description: An array of rules within the ruleset. type: array - items: *196 + items: *198 examples: default: value: @@ -22404,9 +22667,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *195 examples: - default: *194 + default: *196 '404': *6 '500': *40 x-github: @@ -22422,7 +22685,7 @@ paths: operationId: repos/delete-enterprise-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset parameters: - *41 - name: ruleset_id @@ -22450,7 +22713,7 @@ paths: operationId: enterprise-admin/get-enterprise-ruleset-history externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-history + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-enterprise-ruleset-history parameters: - *41 - *17 @@ -22468,7 +22731,7 @@ paths: application/json: schema: type: array - items: &197 + items: &199 title: Ruleset version type: object description: The historical version of a ruleset @@ -22492,7 +22755,7 @@ paths: type: string format: date-time examples: - default: &443 + default: &445 value: - version_id: 3 actor: @@ -22525,7 +22788,7 @@ paths: operationId: enterprise-admin/get-enterprise-ruleset-version externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-version + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-enterprise-ruleset-version parameters: - *41 - name: ruleset_id @@ -22545,9 +22808,9 @@ paths: description: Response content: application/json: - schema: &444 + schema: &446 allOf: - - *197 + - *199 - type: object required: - state @@ -22591,16 +22854,16 @@ paths: summary: List secret scanning alerts for an enterprise description: |- Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users. + To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users. tags: - secret-scanning operationId: secret-scanning/list-alerts-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &445 + - &447 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -22611,28 +22874,28 @@ paths: enum: - open - resolved - - &446 + - &448 name: secret_type in: query description: A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token - name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: type: string - - &447 + - &449 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See "[Supported - secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: type: string - - &448 + - &450 name: exclude_providers in: query description: |- @@ -22643,7 +22906,7 @@ paths: required: false schema: type: string - - &449 + - &451 name: providers in: query description: |- @@ -22654,7 +22917,7 @@ paths: required: false schema: type: string - - &450 + - &452 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -22663,7 +22926,7 @@ paths: required: false schema: type: string - - &451 + - &453 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -22682,7 +22945,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &452 + - &454 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -22698,7 +22961,7 @@ paths: - *17 - *110 - *111 - - &453 + - &455 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -22707,7 +22970,7 @@ paths: required: false schema: type: string - - &454 + - &456 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -22716,7 +22979,7 @@ paths: schema: type: boolean default: false - - &455 + - &457 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -22725,7 +22988,7 @@ paths: schema: type: boolean default: false - - &456 + - &458 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -22741,7 +23004,7 @@ paths: application/json: schema: type: array - items: &457 + items: &459 type: object properties: number: *131 @@ -22760,14 +23023,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &756 + state: &758 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &757 + resolution: &759 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -22797,7 +23060,7 @@ paths: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." provider: type: string description: The provider of the secret that was detected. @@ -22884,8 +23147,8 @@ paths: pull request. ' - oneOf: &758 - - &760 + oneOf: &760 + - &762 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -22943,7 +23206,7 @@ paths: - blob_url - commit_sha - commit_url - - &761 + - &763 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -22998,7 +23261,7 @@ paths: - page_url - commit_sha - commit_url - - &762 + - &764 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23018,7 +23281,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &763 + - &765 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23038,7 +23301,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &764 + - &766 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23058,7 +23321,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &765 + - &767 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23072,7 +23335,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &766 + - &768 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23086,7 +23349,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &767 + - &769 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23100,7 +23363,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &768 + - &770 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -23120,7 +23383,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &769 + - &771 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -23140,7 +23403,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &770 + - &772 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -23160,7 +23423,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &771 + - &773 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -23180,7 +23443,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &772 + - &774 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -23228,7 +23491,7 @@ paths: required: *21 nullable: true examples: - default: &458 + default: &460 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -23406,7 +23669,7 @@ paths: headers: Link: *47 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23424,7 +23687,7 @@ paths: operationId: secret-scanning/list-enterprise-pattern-configs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-enterprise-pattern-configurations x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23437,13 +23700,13 @@ paths: description: Response content: application/json: - schema: &459 + schema: &461 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. type: object properties: - pattern_config_version: &200 + pattern_config_version: &202 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -23452,7 +23715,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &199 + items: &201 type: object properties: token_type: @@ -23518,9 +23781,9 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *199 + items: *201 examples: - default: &460 + default: &462 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -23560,7 +23823,7 @@ paths: operationId: secret-scanning/update-enterprise-pattern-configs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#update-enterprise-pattern-configurations x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23575,7 +23838,7 @@ paths: schema: type: object properties: - pattern_config_version: *200 + pattern_config_version: *202 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -23601,7 +23864,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *200 + custom_pattern_version: *202 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -23653,10 +23916,10 @@ paths: operationId: billing/get-github-advanced-security-billing-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &463 + - &465 name: advanced_security_product in: query description: | @@ -23676,7 +23939,7 @@ paths: description: Success content: application/json: - schema: &464 + schema: &466 type: object properties: total_advanced_security_committers: @@ -23731,7 +23994,7 @@ paths: required: - repositories examples: - default: &465 + default: &467 value: total_advanced_security_committers: 2 total_count: 2 @@ -23772,7 +24035,7 @@ paths: operationId: billing/get-all-budgets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-all-budgets + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#get-all-budgets parameters: - *41 - name: page @@ -23942,7 +24205,7 @@ paths: operationId: billing/create-budget externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#create-a-budget + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#create-a-budget parameters: - *41 requestBody: @@ -24138,10 +24401,10 @@ paths: operationId: billing/get-budget externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-a-budget-by-id + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#get-a-budget-by-id parameters: - *41 - - &201 + - &203 name: budget_id description: The ID corresponding to the budget. in: path @@ -24238,7 +24501,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -24256,7 +24519,7 @@ paths: operationId: billing/update-budget externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#update-a-budget + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#update-a-budget parameters: - name: enterprise in: path @@ -24476,10 +24739,10 @@ paths: operationId: billing/delete-budget externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#delete-a-budget parameters: - *41 - - *201 + - *203 responses: '200': description: Response when deleting a budget @@ -24506,7 +24769,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -24521,7 +24784,7 @@ paths: operationId: billing/get-all-cost-centers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-all-cost-centers-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#get-all-cost-centers-for-an-enterprise parameters: - *41 - name: state @@ -24605,7 +24868,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -24620,7 +24883,7 @@ paths: operationId: billing/create-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#create-a-new-cost-center + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#create-a-new-cost-center parameters: - *41 requestBody: @@ -24731,10 +24994,10 @@ paths: operationId: billing/get-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-a-cost-center-by-id + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#get-a-cost-center-by-id parameters: - *41 - - &203 + - &205 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -24791,7 +25054,7 @@ paths: - name - resources examples: - default: &202 + default: &204 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -24805,7 +25068,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -24819,7 +25082,7 @@ paths: operationId: billing/update-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#update-a-cost-center-name + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#update-a-cost-center-name parameters: - name: enterprise in: path @@ -24894,13 +25157,13 @@ paths: - name - resources examples: - default: *202 + default: *204 '400': *14 '403': *29 '404': *6 '409': *121 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -24915,10 +25178,10 @@ paths: operationId: billing/delete-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#delete-a-cost-center + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#delete-a-cost-center parameters: - *41 - - *203 + - *205 responses: '200': description: Response when deleting a cost center @@ -24957,7 +25220,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -24975,10 +25238,10 @@ paths: operationId: billing/add-resource-to-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#add-resources-to-a-cost-center + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#add-resources-to-a-cost-center parameters: - *41 - - *203 + - *205 requestBody: required: true content: @@ -25050,7 +25313,7 @@ paths: '403': *29 '409': *121 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -25067,10 +25330,10 @@ paths: operationId: billing/remove-resource-from-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#remove-resources-from-a-cost-center + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#remove-resources-from-a-cost-center parameters: - *41 - - *203 + - *205 requestBody: required: true content: @@ -25117,7 +25380,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -25135,10 +25398,10 @@ paths: operationId: billing/get-github-billing-premium-request-usage-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *41 - - &206 + - &208 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -25147,7 +25410,7 @@ paths: required: false schema: type: integer - - &208 + - &210 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current @@ -25156,7 +25419,7 @@ paths: required: false schema: type: integer - - &207 + - &209 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -25165,7 +25428,7 @@ paths: required: false schema: type: integer - - &209 + - &211 name: organization description: The organization name to query usage for. The name is not case sensitive. @@ -25185,7 +25448,7 @@ paths: required: false schema: type: string - - &210 + - &212 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -25324,7 +25587,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -25343,7 +25606,7 @@ paths: operationId: billing/list-usage-report-exports externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#list-usage-report-exports + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#list-usage-report-exports parameters: - *41 responses: @@ -25357,7 +25620,7 @@ paths: usage_report_exports: type: array description: List of usage report exports - items: &204 + items: &206 type: object properties: id: @@ -25447,7 +25710,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -25466,7 +25729,7 @@ paths: operationId: billing/create-usage-report-export externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#create-a-usage-report-export + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#create-a-usage-report-export parameters: - *41 requestBody: @@ -25513,9 +25776,9 @@ paths: description: Report export request accepted content: application/json: - schema: *204 + schema: *206 examples: - usage-report-export: &205 + usage-report-export: &207 value: id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 report_type: detailed @@ -25531,7 +25794,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -25550,7 +25813,7 @@ paths: operationId: billing/get-usage-report-export externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#get-a-usage-report-export + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#get-a-usage-report-export parameters: - *41 - name: report_id @@ -25565,14 +25828,14 @@ paths: description: Usage report export details content: application/json: - schema: *204 + schema: *206 examples: - usage-report-export: *205 + usage-report-export: *207 '401': *25 '403': *29 '404': *6 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -25584,16 +25847,16 @@ paths: description: |- Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. - **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." + **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest/billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." tags: - billing operationId: billing/get-github-billing-usage-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-report-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-usage-report-for-an-enterprise parameters: - *41 - - *206 + - *208 - name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -25602,7 +25865,7 @@ paths: required: false schema: type: integer - - *207 + - *209 - name: cost_center_id description: The ID corresponding to a cost center. The default value is no cost center. @@ -25685,7 +25948,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -25706,20 +25969,20 @@ paths: operationId: billing/get-github-billing-usage-summary-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-summary-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-usage-summary-for-an-enterprise parameters: - *41 - - *206 - *208 - - *207 + - *210 - *209 + - *211 - name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *210 + - *212 - name: sku description: The SKU to query for usage. in: query @@ -25852,7 +26115,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -25863,7 +26126,7 @@ paths: summary: Get Copilot metrics for an enterprise team description: |- > [!NOTE] - > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. @@ -25883,10 +26146,10 @@ paths: operationId: copilot/copilot-metrics-for-enterprise-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team parameters: - *41 - - *144 + - *146 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -25906,7 +26169,7 @@ paths: - *19 - name: per_page description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -25918,13 +26181,13 @@ paths: application/json: schema: type: array - items: *211 + items: *213 examples: - default: *212 + default: *214 '500': *40 '403': *29 '404': *6 - '422': *213 + '422': *215 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -25939,7 +26202,7 @@ paths: operationId: enterprise-teams/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#list-enterprise-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - *41 - *17 @@ -25951,9 +26214,9 @@ paths: application/json: schema: type: array - items: *148 + items: *150 examples: - default: *214 + default: *216 headers: Link: *47 '403': *29 @@ -25971,7 +26234,7 @@ paths: operationId: enterprise-teams/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#create-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team parameters: - *41 requestBody: @@ -26003,7 +26266,7 @@ paths: description: | Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. - `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. `all`: The team is assigned to all current and future organizations in the enterprise. enum: - disabled @@ -26014,7 +26277,7 @@ paths: nullable: true type: string description: The ID of the IdP group to assign team membership with. - You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest//rest/scim#list-provisioned-scim-groups-for-an-enterprise). + You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest/rest/scim#list-provisioned-scim-groups-for-an-enterprise). required: - name examples: @@ -26028,9 +26291,9 @@ paths: description: Response content: application/json: - schema: *148 + schema: *150 examples: - default: &219 + default: &221 value: id: 1 name: Justice League @@ -26056,10 +26319,10 @@ paths: operationId: enterprise-team-memberships/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *41 - - &215 + - &217 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -26078,7 +26341,7 @@ paths: type: array items: *4 examples: - default: &216 + default: &218 value: - login: octocat id: 1 @@ -26114,10 +26377,10 @@ paths: operationId: enterprise-team-memberships/bulk-add externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *41 - - *215 + - *217 requestBody: required: true content: @@ -26148,7 +26411,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26163,10 +26426,10 @@ paths: operationId: enterprise-team-memberships/bulk-remove externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *41 - - *215 + - *217 requestBody: required: true content: @@ -26197,7 +26460,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26212,11 +26475,11 @@ paths: operationId: enterprise-team-memberships/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *41 - - *215 - - *146 + - *217 + - *148 responses: '200': description: User is a member of the enterprise team. @@ -26224,7 +26487,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &217 + exampleKey1: &219 value: login: octocat id: 1 @@ -26257,11 +26520,11 @@ paths: operationId: enterprise-team-memberships/add externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *41 - - *215 - - *146 + - *217 + - *148 responses: '201': description: Successfully added team member @@ -26269,7 +26532,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *217 + exampleKey1: *219 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26284,11 +26547,11 @@ paths: operationId: enterprise-team-memberships/remove externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *41 - - *215 - - *146 + - *217 + - *148 responses: '204': description: Response @@ -26307,10 +26570,10 @@ paths: operationId: enterprise-team-organizations/get-assignments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *41 - - *215 + - *217 - *17 - *19 responses: @@ -26322,7 +26585,7 @@ paths: type: array items: *75 examples: - default: &218 + default: &220 value: login: github id: 1 @@ -26350,10 +26613,10 @@ paths: operationId: enterprise-team-organizations/bulk-add externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *41 - - *215 + - *217 requestBody: required: true content: @@ -26383,7 +26646,7 @@ paths: type: array items: *75 examples: - default: &258 + default: &260 value: - login: github id: 1 @@ -26411,10 +26674,10 @@ paths: operationId: enterprise-team-organizations/bulk-remove externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *41 - - *215 + - *217 requestBody: required: true content: @@ -26452,10 +26715,10 @@ paths: operationId: enterprise-team-organizations/get-assignment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *41 - - *215 + - *217 - *89 responses: '200': @@ -26464,7 +26727,7 @@ paths: application/json: schema: *75 examples: - default: *218 + default: *220 '404': description: The team is not assigned to the organization x-github: @@ -26480,10 +26743,10 @@ paths: operationId: enterprise-team-organizations/add externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *41 - - *215 + - *217 - *89 responses: '201': @@ -26492,7 +26755,7 @@ paths: application/json: schema: *75 examples: - default: *218 + default: *220 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26506,10 +26769,10 @@ paths: operationId: enterprise-team-organizations/delete externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *41 - - *215 + - *217 - *89 responses: '204': @@ -26531,10 +26794,10 @@ paths: operationId: enterprise-teams/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *41 - - &220 + - &222 name: team_slug description: The slug of the team name. in: path @@ -26546,9 +26809,9 @@ paths: description: Response content: application/json: - schema: *148 + schema: *150 examples: - default: *219 + default: *221 headers: Link: *47 '403': *29 @@ -26565,10 +26828,10 @@ paths: operationId: enterprise-teams/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *41 - - *220 + - *222 requestBody: required: true content: @@ -26599,7 +26862,7 @@ paths: description: | Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. - `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). `all`: The team is assigned to all current and future organizations in the enterprise. enum: - disabled @@ -26623,9 +26886,9 @@ paths: description: Response content: application/json: - schema: *148 + schema: *150 examples: - default: *219 + default: *221 headers: Link: *47 '403': *29 @@ -26645,10 +26908,10 @@ paths: operationId: enterprise-teams/delete externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *41 - - *220 + - *222 responses: '204': description: Response @@ -26663,7 +26926,7 @@ paths: summary: Enable or disable a security feature description: |- > [!WARNING] - > **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + > **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Enables or disables the specified security feature for all repositories in an enterprise. @@ -26675,7 +26938,7 @@ paths: operationId: secret-scanning/post-security-product-enablement-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature parameters: - *41 - name: security_product @@ -26730,11 +26993,11 @@ paths: operationId: activity/list-public-events externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events parameters: - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -26747,7 +27010,7 @@ paths: application/json: schema: type: array - items: &253 + items: &255 title: Event description: Event type: object @@ -26757,7 +27020,7 @@ paths: type: type: string nullable: true - actor: &221 + actor: &223 title: Actor description: Actor type: object @@ -26797,7 +27060,7 @@ paths: - id - name - url - org: *221 + org: *223 payload: oneOf: - title: CreateEvent @@ -26843,7 +27106,7 @@ paths: properties: action: type: string - discussion: &895 + discussion: &897 title: Discussion description: A Discussion in a repository. type: object @@ -27130,7 +27393,7 @@ paths: - id labels: type: array - items: &226 + items: &228 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -27205,12 +27468,12 @@ paths: properties: action: type: string - issue: &227 + issue: &229 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &676 + properties: &678 id: type: integer format: int64 @@ -27323,7 +27586,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &423 + properties: &425 url: type: string format: uri @@ -27393,7 +27656,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &424 + required: &426 - closed_issues - creator - description @@ -27472,7 +27735,7 @@ paths: timeline_url: type: string format: uri - type: &388 + type: &390 title: Issue Type description: The type of issue. type: object @@ -27533,9 +27796,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *222 - required: *223 - author_association: &224 + properties: *224 + required: *225 + author_association: &226 title: author_association type: string example: OWNER @@ -27550,7 +27813,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &225 + reactions: &227 title: Reaction Rollup type: object properties: @@ -27586,7 +27849,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &815 + sub_issues_summary: &817 title: Sub-issues Summary type: object properties: @@ -27611,7 +27874,7 @@ paths: description: Comments provide a way for people to collaborate on an issue. type: object - properties: &228 + properties: &230 id: description: Unique identifier of the issue comment example: 42 @@ -27654,7 +27917,7 @@ paths: issue_url: type: string format: uri - author_association: *224 + author_association: *226 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend @@ -27665,15 +27928,15 @@ paths: class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 - reactions: *225 + properties: *224 + required: *225 + reactions: *227 pin: title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &699 + properties: &701 pinned_at: type: string format: date-time @@ -27685,11 +27948,11 @@ paths: properties: *20 required: *21 nullable: true - required: &700 + required: &702 - pinned_at - pinned_by nullable: true - required: &229 + required: &231 - id - node_id - html_url @@ -27699,7 +27962,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &816 + issue_dependencies_summary: &818 title: Issue Dependencies Summary type: object properties: @@ -27718,7 +27981,7 @@ paths: - total_blocking issue_field_values: type: array - items: &683 + items: &685 title: Issue Field Value description: A value assigned to an issue field type: object @@ -27779,7 +28042,7 @@ paths: - node_id - data_type - value - required: &677 + required: &679 - assignee - closed_at - comments @@ -27804,10 +28067,10 @@ paths: assignees: type: array items: *4 - label: *226 + label: *228 labels: type: array - items: *226 + items: *228 required: - action - issue @@ -27816,14 +28079,14 @@ paths: properties: action: type: string - issue: *227 - comment: &672 + issue: *229 + comment: &674 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 required: - action - issue @@ -27996,8 +28259,8 @@ paths: title: License Simple description: License Simple type: object - properties: *230 - required: *231 + properties: *232 + required: *233 nullable: true allow_forking: type: boolean @@ -28086,7 +28349,7 @@ paths: type: string number: type: integer - pull_request: &232 + pull_request: &234 title: Pull Request Minimal type: object properties: @@ -28157,10 +28420,10 @@ paths: assignees: type: array items: *4 - label: *226 + label: *228 labels: type: array - items: *226 + items: *228 required: - action - number @@ -28170,7 +28433,7 @@ paths: properties: action: type: string - pull_request: *232 + pull_request: *234 comment: type: object properties: @@ -28421,7 +28684,7 @@ paths: - pull_request updated_at: type: string - pull_request: *232 + pull_request: *234 required: - action - review @@ -28470,7 +28733,7 @@ paths: updated_at: type: string format: date-time - reactions: *225 + reactions: *227 required: - action - comment @@ -28481,7 +28744,7 @@ paths: type: string release: allOf: - - &735 + - &737 title: Release description: A release. type: object @@ -28552,7 +28815,7 @@ paths: author: *4 assets: type: array - items: &736 + items: &738 title: Release Asset description: Data related to a release. type: object @@ -28627,7 +28890,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *225 + reactions: *227 required: - assets_url - upload_url @@ -28719,7 +28982,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28732,23 +28995,23 @@ paths: Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * **Timeline**: The GitHub Enterprise Cloud global public timeline - * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * **Current user public**: The public timeline for the authenticated user * **Current user**: The private timeline for the authenticated user * **Current user actor**: The private timeline for activity created by the authenticated user * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud. - By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." > [!NOTE] - > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. tags: - activity operationId: activity/get-feeds externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/feeds#get-feeds + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/feeds#get-feeds parameters: [] responses: '200': @@ -28800,7 +29063,7 @@ paths: _links: type: object properties: - timeline: &233 + timeline: &235 title: Link With Type description: Hypermedia Link with Type type: object @@ -28812,17 +29075,17 @@ paths: required: - href - type - user: *233 - security_advisories: *233 - current_user: *233 - current_user_public: *233 - current_user_actor: *233 - current_user_organization: *233 + user: *235 + security_advisories: *235 + current_user: *235 + current_user_public: *235 + current_user_actor: *235 + current_user_organization: *235 current_user_organizations: type: array - items: *233 - repository_discussions: *233 - repository_discussions_category: *233 + items: *235 + repository_discussions: *235 + repository_discussions_category: *235 required: - timeline - user @@ -28882,9 +29145,9 @@ paths: operationId: gists/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *234 + - *236 - *17 - *19 responses: @@ -28894,7 +29157,7 @@ paths: application/json: schema: type: array - items: &235 + items: &237 title: Base Gist description: Base Gist type: object @@ -28993,7 +29256,7 @@ paths: - created_at - updated_at examples: - default: &236 + default: &238 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -29058,7 +29321,7 @@ paths: - gists externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#create-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#create-a-gist parameters: [] requestBody: required: true @@ -29114,7 +29377,7 @@ paths: description: Response content: application/json: - schema: &237 + schema: &239 title: Gist Simple description: Gist Simple type: object @@ -29131,7 +29394,7 @@ paths: url: type: string format: uri - user: &822 + user: &824 title: Public User description: Public User type: object @@ -29493,7 +29756,7 @@ paths: truncated: type: boolean examples: - default: &238 + default: &240 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -29589,15 +29852,15 @@ paths: description: |- List public gists sorted by most recently updated to least recently updated. - Note: With [pagination](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + Note: With [pagination](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. tags: - gists operationId: gists/list-public externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-public-gists parameters: - - *234 + - *236 - *17 - *19 responses: @@ -29607,9 +29870,9 @@ paths: application/json: schema: type: array - items: *235 + items: *237 examples: - default: *236 + default: *238 headers: Link: *47 '422': *15 @@ -29629,9 +29892,9 @@ paths: operationId: gists/list-starred externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-starred-gists parameters: - - *234 + - *236 - *17 - *19 responses: @@ -29641,9 +29904,9 @@ paths: application/json: schema: type: array - items: *235 + items: *237 examples: - default: *236 + default: *238 headers: Link: *47 '401': *25 @@ -29660,7 +29923,7 @@ paths: description: |- Gets a specified gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -29668,9 +29931,9 @@ paths: operationId: gists/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#get-a-gist parameters: - - &239 + - &241 name: gist_id description: The unique identifier of the gist. in: path @@ -29682,10 +29945,10 @@ paths: description: Response content: application/json: - schema: *237 + schema: *239 examples: - default: *238 - '403': &242 + default: *240 + '403': &244 description: Forbidden Gist content: application/json: @@ -29722,7 +29985,7 @@ paths: At least one of `description` or `files` is required. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -29730,9 +29993,9 @@ paths: operationId: gists/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#update-a-gist parameters: - - *239 + - *241 requestBody: required: true content: @@ -29792,9 +30055,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *239 examples: - updateGist: *238 + updateGist: *240 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -29950,9 +30213,9 @@ paths: operationId: gists/delete externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#delete-a-gist parameters: - - *239 + - *241 responses: '204': description: Response @@ -29970,7 +30233,7 @@ paths: description: |- Lists the comments on a gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -29978,9 +30241,9 @@ paths: operationId: gists/list-comments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#list-gist-comments parameters: - - *239 + - *241 - *17 - *19 responses: @@ -29990,7 +30253,7 @@ paths: application/json: schema: type: array - items: &240 + items: &242 title: Gist Comment description: A comment made to a gist. type: object @@ -30025,7 +30288,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *224 + author_association: *226 required: - url - id @@ -30079,7 +30342,7 @@ paths: description: |- Creates a comment on a gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -30087,9 +30350,9 @@ paths: operationId: gists/create-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#create-a-gist-comment parameters: - - *239 + - *241 requestBody: required: true content: @@ -30114,9 +30377,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *242 examples: - default: &241 + default: &243 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -30163,7 +30426,7 @@ paths: description: |- Gets a comment on a gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -30171,10 +30434,10 @@ paths: operationId: gists/get-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#get-a-gist-comment parameters: - - *239 - - &243 + - *241 + - &245 name: comment_id description: The unique identifier of the comment. in: path @@ -30187,12 +30450,12 @@ paths: description: Response content: application/json: - schema: *240 + schema: *242 examples: - default: *241 + default: *243 '304': *37 '404': *6 - '403': *242 + '403': *244 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -30203,7 +30466,7 @@ paths: description: |- Updates a comment on a gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -30211,10 +30474,10 @@ paths: operationId: gists/update-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#update-a-gist-comment parameters: - - *239 - - *243 + - *241 + - *245 requestBody: required: true content: @@ -30239,9 +30502,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *242 examples: - default: *241 + default: *243 '404': *6 x-github: githubCloudOnly: false @@ -30256,10 +30519,10 @@ paths: operationId: gists/delete-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#delete-a-gist-comment parameters: - - *239 - - *243 + - *241 + - *245 responses: '204': description: Response @@ -30280,9 +30543,9 @@ paths: operationId: gists/list-commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gist-commits parameters: - - *239 + - *241 - *17 - *19 responses: @@ -30381,9 +30644,9 @@ paths: operationId: gists/list-forks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gist-forks parameters: - - *239 + - *241 - *17 - *19 responses: @@ -30393,7 +30656,7 @@ paths: application/json: schema: type: array - items: *237 + items: *239 examples: default: value: @@ -30456,15 +30719,15 @@ paths: operationId: gists/fork externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#fork-a-gist parameters: - - *239 + - *241 responses: '201': description: Response content: application/json: - schema: *235 + schema: *237 examples: default: value: @@ -30533,9 +30796,9 @@ paths: operationId: gists/check-is-starred externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *239 + - *241 responses: '204': description: Response if gist is starred @@ -30557,15 +30820,15 @@ paths: put: summary: Star a gist description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - gists operationId: gists/star externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#star-a-gist parameters: - - *239 + - *241 responses: '204': description: Response @@ -30585,9 +30848,9 @@ paths: operationId: gists/unstar externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#unstar-a-gist parameters: - - *239 + - *241 responses: '204': description: Response @@ -30605,7 +30868,7 @@ paths: description: |- Gets a specified gist revision. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -30613,9 +30876,9 @@ paths: operationId: gists/get-revision externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#get-a-gist-revision parameters: - - *239 + - *241 - name: sha in: path required: true @@ -30626,9 +30889,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *239 examples: - default: *238 + default: *240 '422': *15 '404': *6 '403': *29 @@ -30641,13 +30904,13 @@ paths: get: summary: Get all gitignore templates description: List all templates available to pass as an option when [creating - a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user). + a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user). operationId: gitignore/get-all-templates tags: - gitignore externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-all-gitignore-templates + url: https://docs.github.com/enterprise-cloud@latest/rest/gitignore/gitignore#get-all-gitignore-templates parameters: [] responses: '200': @@ -30680,7 +30943,7 @@ paths: description: |- Get the content of a gitignore template. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. operationId: gitignore/get-template @@ -30688,7 +30951,7 @@ paths: - gitignore externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-a-gitignore-template + url: https://docs.github.com/enterprise-cloud@latest/rest/gitignore/gitignore#get-a-gitignore-template parameters: - name: name in: path @@ -30768,7 +31031,7 @@ paths: operationId: apps/list-repos-accessible-to-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-repositories-accessible-to-the-app-installation parameters: - *17 - *19 @@ -30927,13 +31190,13 @@ paths: description: |- Revokes the installation token you're using to authenticate as an installation and access this endpoint. - Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. tags: - apps operationId: apps/revoke-installation-access-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#revoke-an-installation-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#revoke-an-installation-access-token parameters: [] responses: '204': @@ -30952,9 +31215,9 @@ paths: necessarily assigned to you. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -30965,7 +31228,7 @@ paths: operationId: issues/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-issues-assigned-to-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues @@ -30996,7 +31259,7 @@ paths: - closed - all default: open - - &391 + - &393 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -31015,7 +31278,7 @@ paths: - comments default: created - *112 - - *234 + - *236 - name: collab in: query required: false @@ -31045,9 +31308,9 @@ paths: application/json: schema: type: array - items: *227 + items: *229 examples: - default: &392 + default: &394 value: - id: 1 node_id: MDU6SXNzdWUx @@ -31305,13 +31568,13 @@ paths: get: summary: Get all commonly used licenses description: Lists the most commonly used licenses on GitHub. For more information, - see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - licenses operationId: licenses/get-all-commonly-used externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-all-commonly-used-licenses + url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-all-commonly-used-licenses parameters: - name: featured in: query @@ -31331,8 +31594,8 @@ paths: title: License Simple description: License Simple type: object - properties: *230 - required: *231 + properties: *232 + required: *233 examples: default: value: @@ -31381,13 +31644,13 @@ paths: get: summary: Get a license description: Gets information about a specific license. For more information, - see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - licenses operationId: licenses/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-a-license + url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-a-license parameters: - name: license in: path @@ -31572,7 +31835,7 @@ paths: - markdown externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document + url: https://docs.github.com/enterprise-cloud@latest/rest/markdown/markdown#render-a-markdown-document parameters: [] requestBody: required: true @@ -31617,7 +31880,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &244 + X-CommonMarker-Version: &246 example: 0.17.4 schema: type: string @@ -31648,7 +31911,7 @@ paths: - markdown externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document-in-raw-mode + url: https://docs.github.com/enterprise-cloud@latest/rest/markdown/markdown#render-a-markdown-document-in-raw-mode parameters: [] requestBody: required: false @@ -31672,7 +31935,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *244 + X-CommonMarker-Version: *246 content: text/html: schema: @@ -31693,15 +31956,15 @@ paths: description: |- Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/get-subscription-plan-for-account externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &247 + - &249 name: account_id description: account_id parameter in: path @@ -31713,7 +31976,7 @@ paths: description: Response content: application/json: - schema: &246 + schema: &248 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -31743,7 +32006,7 @@ paths: nullable: true id: type: integer - plan: &245 + plan: &247 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -31832,7 +32095,7 @@ paths: nullable: true updated_at: type: string - plan: *245 + plan: *247 required: - url - id @@ -31840,7 +32103,7 @@ paths: - login - marketplace_purchase examples: - default: &248 + default: &250 value: url: https://api.github.com/orgs/github type: Organization @@ -31908,13 +32171,13 @@ paths: description: |- Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-plans externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-plans parameters: - *17 - *19 @@ -31925,9 +32188,9 @@ paths: application/json: schema: type: array - items: *245 + items: *247 examples: - default: &249 + default: &251 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -31959,22 +32222,22 @@ paths: description: |- Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-accounts-for-plan externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &250 + - &252 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &251 + - &253 name: sort description: The property to sort the results by. in: query @@ -32004,9 +32267,9 @@ paths: application/json: schema: type: array - items: *246 + items: *248 examples: - default: &252 + default: &254 value: - url: https://api.github.com/orgs/github type: Organization @@ -32072,23 +32335,23 @@ paths: description: |- Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/get-subscription-plan-for-account-stubbed externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *247 + - *249 responses: '200': description: Response content: application/json: - schema: *246 + schema: *248 examples: - default: *248 + default: *250 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -32103,13 +32366,13 @@ paths: description: |- Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-plans-stubbed externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans-stubbed + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-plans-stubbed parameters: - *17 - *19 @@ -32120,9 +32383,9 @@ paths: application/json: schema: type: array - items: *245 + items: *247 examples: - default: *249 + default: *251 headers: Link: *47 '401': *25 @@ -32137,16 +32400,16 @@ paths: description: |- Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-accounts-for-plan-stubbed externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *250 - - *251 + - *252 + - *253 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -32166,9 +32429,9 @@ paths: application/json: schema: type: array - items: *246 + items: *248 examples: - default: *252 + default: *254 headers: Link: *47 '401': *25 @@ -32181,7 +32444,7 @@ paths: get: summary: Get GitHub Enterprise Cloud meta information description: |- - Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/)." + Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest/articles/about-github-s-ip-addresses/)." The API's response also includes a list of GitHub's domain names. @@ -32194,7 +32457,7 @@ paths: operationId: meta/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-apiname-meta-information + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-apiname-meta-information parameters: [] responses: '200': @@ -32430,16 +32693,16 @@ paths: operationId: activity/list-public-events-for-repo-network externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &478 + - &480 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &479 + - &481 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -32456,7 +32719,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: default: value: @@ -32501,7 +32764,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &484 + '301': &486 description: Moved permanently content: application/json: @@ -32521,9 +32784,9 @@ paths: operationId: activity/list-notifications-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &709 + - &711 name: all description: If `true`, show notifications marked as read. in: query @@ -32531,7 +32794,7 @@ paths: schema: type: boolean default: false - - &710 + - &712 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -32540,8 +32803,8 @@ paths: schema: type: boolean default: false - - *234 - - &711 + - *236 + - &713 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -32554,7 +32817,7 @@ paths: - *19 - name: per_page description: The number of results per page (max 50). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -32566,18 +32829,18 @@ paths: application/json: schema: type: array - items: &254 + items: &256 title: Thread description: Thread type: object properties: id: type: string - repository: &288 + repository: &290 title: Minimal Repository description: Minimal Repository type: object - properties: &356 + properties: &358 id: type: integer format: int64 @@ -32863,7 +33126,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &437 + security_and_analysis: &439 nullable: true type: object properties: @@ -32991,7 +33254,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &357 + required: &359 - archive_url - assignees_url - blobs_url @@ -33079,7 +33342,7 @@ paths: - url - subscription_url examples: - default: &712 + default: &714 value: - id: '1' repository: @@ -33177,14 +33440,14 @@ paths: number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications - remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user) + remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity operationId: activity/mark-notifications-as-read externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-notifications-as-read + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-notifications-as-read parameters: [] requestBody: required: false @@ -33243,13 +33506,13 @@ paths: operationId: activity/get-thread externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#get-a-thread parameters: - - &255 + - &257 name: thread_id 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/activity/notifications#list-notifications-for-the-authenticated-user)). + (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -33259,7 +33522,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *256 examples: default: value: @@ -33360,9 +33623,9 @@ paths: operationId: activity/mark-thread-as-read externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-a-thread-as-read parameters: - - *255 + - *257 responses: '205': description: Reset Content @@ -33383,9 +33646,9 @@ paths: operationId: activity/mark-thread-as-done externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-a-thread-as-done parameters: - - *255 + - *257 responses: '204': description: No content @@ -33398,7 +33661,7 @@ paths: get: summary: Get a thread subscription for the authenticated user description: |- - This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription). + This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription). Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. tags: @@ -33406,15 +33669,15 @@ paths: operationId: activity/get-thread-subscription-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *255 + - *257 responses: '200': description: Response content: application/json: - schema: &256 + schema: &258 title: Thread Subscription description: Thread Subscription type: object @@ -33451,7 +33714,7 @@ paths: - url - subscribed examples: - default: &257 + default: &259 value: subscribed: true ignored: false @@ -33474,15 +33737,15 @@ paths: You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription) endpoint. + Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#delete-a-thread-subscription) endpoint. tags: - activity operationId: activity/set-thread-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#set-a-thread-subscription parameters: - - *255 + - *257 requestBody: required: false content: @@ -33503,9 +33766,9 @@ paths: description: Response content: application/json: - schema: *256 + schema: *258 examples: - default: *257 + default: *259 '304': *37 '403': *29 '401': *25 @@ -33519,16 +33782,16 @@ paths: description: Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications - for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription) + for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. tags: - activity operationId: activity/delete-thread-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#delete-a-thread-subscription parameters: - - *255 + - *257 responses: '204': description: Response @@ -33587,7 +33850,7 @@ paths: :~==~==~==~==~~ externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-octocat + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-octocat x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33600,13 +33863,13 @@ paths: Lists all organizations, in the order that they were created. > [!NOTE] - > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. tags: - orgs operationId: orgs/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations parameters: - name: since description: An organization ID. Only return organizations with an ID greater @@ -33625,7 +33888,7 @@ paths: type: array items: *75 examples: - default: *258 + default: *260 headers: Link: example: ; rel="next" @@ -33642,9 +33905,9 @@ paths: summary: Closing down - List custom repository roles in an organization description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. - List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. @@ -33654,7 +33917,7 @@ paths: operationId: orgs/list-custom-roles externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization parameters: - name: organization_id description: The unique identifier of the organization. @@ -33676,7 +33939,7 @@ paths: type: integer custom_roles: type: array - items: &334 + items: &336 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -33724,7 +33987,7 @@ paths: - created_at - updated_at examples: - default: &335 + default: &337 value: id: 8030 name: Security Engineer @@ -33769,7 +34032,7 @@ paths: operationId: actions/get-actions-cache-retention-limit-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization parameters: - *89 responses: @@ -33777,7 +34040,7 @@ paths: description: Response content: application/json: - schema: &259 + schema: &261 title: Actions cache retention limit for an organization description: GitHub Actions cache retention policy for an organization. type: object @@ -33808,14 +34071,14 @@ paths: operationId: actions/set-actions-cache-retention-limit-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization parameters: - *89 requestBody: required: true content: application/json: - schema: *259 + schema: *261 examples: selected_actions: *44 responses: @@ -33842,7 +34105,7 @@ paths: operationId: actions/get-actions-cache-storage-limit-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization parameters: - *89 responses: @@ -33850,7 +34113,7 @@ paths: description: Response content: application/json: - schema: &260 + schema: &262 title: Actions cache storage limit for an organization description: GitHub Actions cache storage policy for an organization. type: object @@ -33881,14 +34144,14 @@ paths: operationId: actions/set-actions-cache-storage-limit-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization parameters: - *89 requestBody: required: true content: application/json: - schema: *260 + schema: *262 examples: selected_actions: *46 responses: @@ -33919,7 +34182,7 @@ paths: operationId: orgs/custom-properties-for-orgs-get-organization-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization parameters: - *89 responses: @@ -33929,9 +34192,9 @@ paths: application/json: schema: type: array - items: *158 + items: *160 examples: - default: &718 + default: &720 value: - property_name: environment value: production @@ -33963,7 +34226,7 @@ paths: operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization parameters: - *89 requestBody: @@ -33977,11 +34240,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the organization. - items: *158 + items: *160 required: - properties examples: - default: &719 + default: &721 value: properties: - property_name: environment @@ -34008,7 +34271,7 @@ paths: description: |- Gets information about an organization. - When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/). + When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest/articles/securing-your-account-with-two-factor-authentication-2fa/). To see the full details about an organization, the authenticated user must be an organization owner. @@ -34020,7 +34283,7 @@ paths: operationId: orgs/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-an-organization parameters: - *89 responses: @@ -34028,7 +34291,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &263 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -34245,7 +34508,7 @@ paths: type: boolean example: false description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. @@ -34255,7 +34518,7 @@ paths: type: boolean example: false description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. @@ -34265,7 +34528,7 @@ paths: type: boolean example: false description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. @@ -34275,7 +34538,7 @@ paths: type: boolean example: false description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. @@ -34285,7 +34548,7 @@ paths: type: boolean example: false description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. @@ -34295,7 +34558,7 @@ paths: type: boolean example: false description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. @@ -34316,7 +34579,7 @@ paths: type: boolean example: false description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true @@ -34361,7 +34624,7 @@ paths: - updated_at - archived_at examples: - default-response: &262 + default-response: &264 value: login: github id: 1 @@ -34449,7 +34712,7 @@ paths: > **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). > [!WARNING] - > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). Updates the organization's profile and member privileges. @@ -34461,7 +34724,7 @@ paths: operationId: orgs/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#update-an-organization parameters: - *89 requestBody: @@ -34524,20 +34787,20 @@ paths: members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, - see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_can_create_private_repositories: type: boolean description: Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your - organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_can_create_public_repositories: type: boolean description: Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting - repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_allowed_repository_creation_type: type: string @@ -34585,66 +34848,66 @@ paths: advanced_security_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependency_graph_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true secret_scanning_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true @@ -34660,7 +34923,7 @@ paths: secret_scanning_validity_checks_enabled: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true @@ -34686,17 +34949,17 @@ paths: description: Response content: application/json: - schema: *261 + schema: *263 examples: - default: *262 + default: *264 '422': description: Validation failed content: application/json: schema: oneOf: - - *263 - - *264 + - *265 + - *266 '409': *121 x-github: githubCloudOnly: false @@ -34712,13 +34975,13 @@ paths: Please review the Terms of Service regarding account deletion before using this endpoint: - https://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service + https://docs.github.com/enterprise-cloud@latest/site-policy/github-terms/github-terms-of-service operationId: orgs/delete tags: - orgs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#delete-an-organization parameters: - *89 responses: @@ -34743,7 +35006,7 @@ paths: operationId: actions/get-actions-cache-usage-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - *89 responses: @@ -34751,9 +35014,9 @@ paths: description: Response content: application/json: - schema: *265 + schema: *267 examples: - default: *266 + default: *268 headers: Link: *47 x-github: @@ -34774,7 +35037,7 @@ paths: operationId: actions/get-actions-cache-usage-by-repo-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - *89 - *17 @@ -34794,7 +35057,7 @@ paths: type: integer repository_cache_usages: type: array - items: &491 + items: &493 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -34847,7 +35110,7 @@ paths: operationId: actions/list-hosted-runners-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - *89 - *17 @@ -34869,7 +35132,7 @@ paths: type: array items: *48 examples: - default: *267 + default: *269 headers: Link: *47 x-github: @@ -34887,7 +35150,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - *89 requestBody: @@ -34986,7 +35249,7 @@ paths: operationId: actions/list-custom-images-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - *89 responses: @@ -35024,7 +35287,7 @@ paths: operationId: actions/get-custom-image-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - *89 - *50 @@ -35035,7 +35298,7 @@ paths: application/json: schema: *49 examples: - default: *268 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35052,7 +35315,7 @@ paths: operationId: actions/delete-custom-image-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - *89 - *50 @@ -35076,7 +35339,7 @@ paths: operationId: actions/list-custom-image-versions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - *50 - *89 @@ -35115,7 +35378,7 @@ paths: operationId: actions/get-custom-image-version-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - *89 - *50 @@ -35127,7 +35390,7 @@ paths: application/json: schema: *52 examples: - default: *269 + default: *271 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35144,7 +35407,7 @@ paths: operationId: actions/delete-custom-image-version-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - *89 - *50 @@ -35167,7 +35430,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - *89 responses: @@ -35203,7 +35466,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - *89 responses: @@ -35238,7 +35501,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - *89 responses: @@ -35246,9 +35509,9 @@ paths: description: Response content: application/json: - schema: *270 + schema: *272 examples: - default: *271 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35264,7 +35527,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - *89 responses: @@ -35284,7 +35547,7 @@ paths: type: array items: *56 examples: - default: *272 + default: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35300,7 +35563,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - *89 responses: @@ -35344,7 +35607,7 @@ paths: operationId: actions/get-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *89 - *58 @@ -35373,7 +35636,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *89 - *58 @@ -35458,7 +35721,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *89 - *58 @@ -35487,7 +35750,7 @@ paths: operationId: oidc/list-oidc-custom-property-inclusions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization parameters: - *89 responses: @@ -35520,14 +35783,14 @@ paths: operationId: oidc/create-oidc-custom-property-inclusion-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization parameters: - *89 requestBody: required: true content: application/json: - schema: *273 + schema: *275 examples: default: *60 responses: @@ -35559,7 +35822,7 @@ paths: operationId: oidc/delete-oidc-custom-property-inclusion-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization parameters: - *89 - name: custom_property_name @@ -35592,7 +35855,7 @@ paths: operationId: oidc/get-oidc-custom-sub-template-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - *89 responses: @@ -35611,10 +35874,16 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the + name-based format. + type: boolean required: - include_claim_keys examples: - default: &274 + default: &276 value: include_claim_keys: - repo @@ -35634,7 +35903,7 @@ paths: operationId: oidc/update-oidc-custom-sub-template-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - *89 requestBody: @@ -35652,14 +35921,20 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: - default: *274 + default: *276 responses: '201': description: Empty response content: application/json: - schema: &299 + schema: &301 title: Empty Object description: An object without any properties. type: object @@ -35687,7 +35962,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - *89 responses: @@ -35698,7 +35973,7 @@ paths: schema: type: object properties: - enabled_repositories: &276 + enabled_repositories: &278 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -35712,7 +35987,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *62 - selected_actions_url: *275 + selected_actions_url: *277 sha_pinning_required: *63 required: - enabled_repositories @@ -35741,7 +36016,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - *89 responses: @@ -35754,7 +36029,7 @@ paths: schema: type: object properties: - enabled_repositories: *276 + enabled_repositories: *278 allowed_actions: *62 sha_pinning_required: *63 required: @@ -35782,7 +36057,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - *89 responses: @@ -35790,7 +36065,7 @@ paths: description: Response content: application/json: - schema: *277 + schema: *279 examples: response: summary: Example response @@ -35814,14 +36089,14 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - *89 requestBody: required: true content: application/json: - schema: *278 + schema: *280 examples: application/json: value: @@ -35849,7 +36124,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - *89 responses: @@ -35859,7 +36134,7 @@ paths: application/json: schema: *64 examples: - default: *279 + default: *281 '404': *6 x-github: enabledForGitHubApps: true @@ -35876,7 +36151,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - *89 responses: @@ -35908,7 +36183,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - *89 responses: @@ -35916,7 +36191,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *282 examples: default: *65 '403': *29 @@ -35934,14 +36209,14 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - *89 requestBody: required: true content: application/json: - schema: *281 + schema: *283 examples: default: *65 responses: @@ -35971,7 +36246,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - *89 - *17 @@ -35993,7 +36268,7 @@ paths: type: array items: *80 examples: - default: &283 + default: &285 value: total_count: 1 repositories: @@ -36131,7 +36406,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - *89 responses: @@ -36175,10 +36450,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *89 - - &282 + - &284 name: repository_id description: The unique identifier of the repository. in: path @@ -36204,10 +36479,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *89 - - *282 + - *284 responses: '204': description: Response @@ -36228,7 +36503,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - *89 responses: @@ -36259,7 +36534,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - *89 responses: @@ -36289,7 +36564,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - *89 responses: @@ -36337,7 +36612,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - *89 requestBody: @@ -36384,7 +36659,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *89 - *17 @@ -36403,7 +36678,7 @@ paths: type: array items: *80 examples: - default: *283 + default: *285 '403': *29 '404': *6 x-github: @@ -36421,7 +36696,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *89 requestBody: @@ -36469,10 +36744,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *89 - - *282 + - *284 responses: '204': description: No content @@ -36496,10 +36771,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *89 - - *282 + - *284 responses: '204': description: No content @@ -36517,7 +36792,7 @@ paths: description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -36525,7 +36800,7 @@ paths: operationId: actions/get-github-actions-default-workflow-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - *89 responses: @@ -36533,7 +36808,7 @@ paths: description: Response content: application/json: - schema: *284 + schema: *286 examples: default: *71 x-github: @@ -36546,7 +36821,7 @@ paths: description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions can submit approving pull request reviews. For more information, see - "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -36554,7 +36829,7 @@ paths: operationId: actions/set-github-actions-default-workflow-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - *89 responses: @@ -36567,7 +36842,7 @@ paths: required: false content: application/json: - schema: *285 + schema: *287 examples: default: *71 x-github: @@ -36587,7 +36862,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - *89 - *17 @@ -36614,7 +36889,7 @@ paths: type: number runner_groups: type: array - items: &286 + items: &288 type: object properties: id: @@ -36728,7 +37003,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - *89 requestBody: @@ -36802,9 +37077,9 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - default: &287 + default: &289 value: id: 2 name: octo-runner-group @@ -36837,7 +37112,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *89 - *74 @@ -36846,7 +37121,7 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: default: value: @@ -36880,7 +37155,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *89 - *74 @@ -36937,9 +37212,9 @@ paths: description: Response content: application/json: - schema: *286 + schema: *288 examples: - default: *287 + default: *289 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -36956,7 +37231,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *89 - *74 @@ -36980,7 +37255,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *89 - *74 @@ -37003,7 +37278,7 @@ paths: type: array items: *48 examples: - default: *267 + default: *269 headers: Link: *47 x-github: @@ -37023,7 +37298,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *89 - *74 @@ -37044,9 +37319,9 @@ paths: type: number repositories: type: array - items: *288 + items: *290 examples: - default: &332 + default: &334 value: total_count: 1 repositories: @@ -37296,7 +37571,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - *89 - *74 @@ -37341,11 +37616,11 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *89 - *74 - - *282 + - *284 responses: '204': description: Response @@ -37365,11 +37640,11 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *89 - *74 - - *282 + - *284 responses: '204': description: Response @@ -37390,7 +37665,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *89 - *74 @@ -37432,7 +37707,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *89 - *74 @@ -37477,7 +37752,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - *89 - *74 @@ -37501,7 +37776,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - *89 - *74 @@ -37528,7 +37803,7 @@ paths: operationId: actions/list-self-hosted-runners-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization parameters: - name: name description: The name of a self-hosted runner. @@ -37577,7 +37852,7 @@ paths: operationId: actions/list-runner-applications-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - *89 responses: @@ -37587,9 +37862,9 @@ paths: application/json: schema: type: array - items: *289 + items: *291 examples: - default: *290 + default: *292 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37609,7 +37884,7 @@ paths: operationId: actions/generate-runner-jitconfig-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - *89 requestBody: @@ -37654,7 +37929,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *291 + '201': *293 '404': *6 '422': *7 '409': *121 @@ -37683,7 +37958,7 @@ paths: operationId: actions/create-registration-token-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - *89 responses: @@ -37693,7 +37968,7 @@ paths: application/json: schema: *81 examples: - default: *292 + default: *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37719,7 +37994,7 @@ paths: operationId: actions/create-remove-token-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - *89 responses: @@ -37729,7 +38004,7 @@ paths: application/json: schema: *81 examples: - default: *293 + default: *295 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37749,7 +38024,7 @@ paths: operationId: actions/get-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *89 - *77 @@ -37760,7 +38035,7 @@ paths: application/json: schema: *78 examples: - default: *294 + default: *296 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37779,7 +38054,7 @@ paths: operationId: actions/delete-self-hosted-runner-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *89 - *77 @@ -37806,7 +38081,7 @@ paths: operationId: actions/list-labels-for-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *89 - *77 @@ -37831,7 +38106,7 @@ paths: operationId: actions/add-custom-labels-to-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *89 - *77 @@ -37880,7 +38155,7 @@ paths: operationId: actions/set-custom-labels-for-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *89 - *77 @@ -37930,12 +38205,12 @@ paths: operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - *89 - *77 responses: - '200': *295 + '200': *297 '404': *6 x-github: githubCloudOnly: false @@ -37960,11 +38235,11 @@ paths: operationId: actions/remove-custom-label-from-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - *89 - *77 - - *296 + - *298 responses: '200': *83 '404': *6 @@ -37989,7 +38264,7 @@ paths: operationId: actions/list-org-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-organization-secrets parameters: - *89 - *17 @@ -38009,7 +38284,7 @@ paths: type: integer secrets: type: array - items: &297 + items: &299 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -38080,7 +38355,7 @@ paths: operationId: actions/get-org-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-public-key parameters: - *89 responses: @@ -38088,7 +38363,7 @@ paths: description: Response content: application/json: - schema: &511 + schema: &513 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -38117,7 +38392,7 @@ paths: - key_id - key examples: - default: &512 + default: &514 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -38140,10 +38415,10 @@ paths: operationId: actions/get-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-secret parameters: - *89 - - &298 + - &300 name: secret_name description: The name of the secret. in: path @@ -38155,7 +38430,7 @@ paths: description: Response content: application/json: - schema: *297 + schema: *299 examples: default: value: @@ -38173,7 +38448,7 @@ paths: summary: Create or update an organization secret description: |- Creates or updates an organization secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -38183,10 +38458,10 @@ paths: operationId: actions/create-or-update-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *89 - - *298 + - *300 requestBody: required: true content: @@ -38198,7 +38473,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public - key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -38219,9 +38494,9 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) + an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -38243,7 +38518,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -38267,10 +38542,10 @@ paths: operationId: actions/delete-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-organization-secret parameters: - *89 - - *298 + - *300 responses: '204': description: Response @@ -38294,10 +38569,10 @@ paths: operationId: actions/list-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *89 - - *298 + - *300 - *19 - *17 responses: @@ -38315,9 +38590,9 @@ paths: type: integer repositories: type: array - items: *288 + items: *290 examples: - default: &302 + default: &304 value: total_count: 1 repositories: @@ -38397,7 +38672,7 @@ paths: description: |- Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -38407,10 +38682,10 @@ paths: operationId: actions/set-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *89 - - *298 + - *300 requestBody: required: true content: @@ -38424,8 +38699,8 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization - secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) + secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -38450,7 +38725,7 @@ paths: description: |- Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. For more information about setting the visibility, see [Create or - update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -38460,10 +38735,10 @@ paths: operationId: actions/add-selected-repo-to-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *89 - - *298 + - *300 - name: repository_id in: path required: true @@ -38484,7 +38759,7 @@ paths: description: |- Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -38494,10 +38769,10 @@ paths: operationId: actions/remove-selected-repo-from-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *89 - - *298 + - *300 - name: repository_id in: path required: true @@ -38527,13 +38802,13 @@ paths: operationId: actions/list-org-variables externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables parameters: - *89 - - &496 + - &498 name: per_page description: The number of results per page (max 30). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -38554,7 +38829,7 @@ paths: type: integer variables: type: array - items: &300 + items: &302 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -38637,7 +38912,7 @@ paths: operationId: actions/create-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-organization-variable parameters: - *89 requestBody: @@ -38687,7 +38962,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -38710,10 +38985,10 @@ paths: operationId: actions/get-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-organization-variable parameters: - *89 - - &301 + - &303 name: name description: The name of the variable. in: path @@ -38725,7 +39000,7 @@ paths: description: Response content: application/json: - schema: *300 + schema: *302 examples: default: value: @@ -38753,10 +39028,10 @@ paths: operationId: actions/update-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-organization-variable parameters: - *89 - - *301 + - *303 requestBody: required: true content: @@ -38816,10 +39091,10 @@ paths: operationId: actions/delete-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-organization-variable parameters: - *89 - - *301 + - *303 responses: '204': description: Response @@ -38843,10 +39118,10 @@ paths: operationId: actions/list-selected-repos-for-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *89 - - *301 + - *303 - *19 - *17 responses: @@ -38864,9 +39139,9 @@ paths: type: integer repositories: type: array - items: *288 + items: *290 examples: - default: *302 + default: *304 '409': description: Response when the visibility of the variable is not set to `selected` @@ -38890,10 +39165,10 @@ paths: operationId: actions/set-selected-repos-for-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *89 - - *301 + - *303 requestBody: required: true content: @@ -38940,10 +39215,10 @@ paths: operationId: actions/add-selected-repo-to-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *89 - - *301 + - *303 - name: repository_id in: path required: true @@ -38975,10 +39250,10 @@ paths: operationId: actions/remove-selected-repo-from-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *89 - - *301 + - *303 - name: repository_id in: path required: true @@ -39007,7 +39282,7 @@ paths: operationId: announcement-banners/get-announcement-banner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - *89 responses: @@ -39031,12 +39306,12 @@ paths: operationId: announcement-banners/set-announcement-banner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#set-announcement-banner-for-organization requestBody: required: true content: application/json: - schema: *303 + schema: *305 examples: default: *87 parameters: @@ -39062,7 +39337,7 @@ paths: operationId: announcement-banners/remove-announcement-banner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - *89 responses: @@ -39095,7 +39370,7 @@ paths: operationId: orgs/create-artifact-deployment-record externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-an-artifact-deployment-record + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - *89 requestBody: @@ -39220,7 +39495,7 @@ paths: type: integer deployment_records: type: array - items: &304 + items: &306 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -39266,7 +39541,7 @@ paths: required: - total_count examples: - default: &305 + default: &307 value: total_count: 1 deployment_records: @@ -39301,7 +39576,7 @@ paths: operationId: orgs/set-cluster-deployment-records externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - *89 - name: cluster @@ -39446,11 +39721,11 @@ paths: type: integer deployment_records: type: array - items: *304 + items: *306 required: - total_count examples: - default: *305 + default: *307 '403': description: Forbidden content: @@ -39495,7 +39770,7 @@ paths: operationId: orgs/create-artifact-storage-record externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - *89 requestBody: @@ -39658,7 +39933,7 @@ paths: operationId: orgs/list-artifact-deployment-records externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-deployment-records + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - *89 - name: subject_digest @@ -39685,9 +39960,9 @@ paths: type: integer deployment_records: type: array - items: *304 + items: *306 examples: - default: *305 + default: *307 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39705,7 +39980,7 @@ paths: operationId: orgs/list-artifact-storage-records externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - *89 - name: subject_digest @@ -39781,13 +40056,13 @@ paths: The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - orgs operationId: orgs/list-attestations-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - *110 @@ -39816,12 +40091,12 @@ paths: required: - subject_digests examples: - default: &854 + default: &856 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &855 + withPredicateType: &857 value: subject_digests: - sha256:abc123 @@ -39879,7 +40154,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &856 + default: &858 value: attestations_subject_digests: - sha256:abc: @@ -39986,7 +40261,7 @@ paths: operationId: orgs/delete-attestations-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-in-bulk parameters: - *89 requestBody: @@ -40051,7 +40326,7 @@ paths: operationId: orgs/delete-attestations-by-subject-digest externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - *89 - name: subject_digest @@ -40083,7 +40358,7 @@ paths: operationId: orgs/list-attestation-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestation-repositories parameters: - *17 - *110 @@ -40134,7 +40409,7 @@ paths: operationId: orgs/delete-attestations-by-id externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-by-id parameters: - *89 - name: attestation_id @@ -40163,13 +40438,13 @@ paths: The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - orgs operationId: orgs/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestations parameters: - *17 - *110 @@ -40229,7 +40504,7 @@ paths: initiator: type: string examples: - default: &525 + default: &527 value: attestations: - bundle: @@ -40329,13 +40604,13 @@ paths: get: summary: Get the audit log for an organization description: |- - Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." - By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." - Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." + Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api)." - This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators)." The authenticated user must be an organization owner to use this endpoint. @@ -40345,20 +40620,20 @@ paths: - orgs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - *89 - name: phrase 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). + 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). in: query required: false schema: type: string - - *306 - - *307 - *308 - *309 + - *310 + - *311 - *17 responses: '200': @@ -40367,9 +40642,9 @@ paths: application/json: schema: type: array - items: *310 + items: *312 examples: - default: *311 + default: *313 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -40384,7 +40659,7 @@ paths: operationId: orgs/list-blocked-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - *89 - *17 @@ -40398,7 +40673,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40415,10 +40690,10 @@ paths: operationId: orgs/check-blocked-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - *89 - - *146 + - *148 responses: '204': description: If the user is blocked @@ -40441,10 +40716,10 @@ paths: operationId: orgs/block-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#block-a-user-from-an-organization parameters: - *89 - - *146 + - *148 responses: '204': description: Response @@ -40462,10 +40737,10 @@ paths: operationId: orgs/unblock-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - *89 - - *146 + - *148 responses: '204': description: Response @@ -40484,7 +40759,7 @@ paths: operationId: orgs/list-push-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -40492,7 +40767,7 @@ paths: subcategory: bypass-requests parameters: - *89 - - &314 + - &316 name: repository_name description: The name of the repository to filter on. in: query @@ -40511,9 +40786,9 @@ paths: application/json: schema: type: array - items: *312 + items: *314 examples: - default: *313 + default: *315 '404': *6 '500': *40 "/orgs/{org}/bypass-requests/secret-scanning": @@ -40529,7 +40804,7 @@ paths: operationId: secret-scanning/list-org-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -40537,7 +40812,7 @@ paths: subcategory: delegated-bypass parameters: - *89 - - *314 + - *316 - *105 - *106 - *107 @@ -40551,9 +40826,9 @@ paths: application/json: schema: type: array - items: *315 + items: *317 examples: - default: *316 + default: *318 '404': *6 '500': *40 "/orgs/{org}/campaigns": @@ -40570,7 +40845,7 @@ paths: operationId: campaigns/list-org-campaigns externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - *89 - *19 @@ -40580,7 +40855,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &318 + schema: &320 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -40606,7 +40881,7 @@ paths: application/json: schema: type: array - items: &319 + items: &321 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -40637,7 +40912,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *317 + items: *319 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -40655,7 +40930,7 @@ paths: type: string format: date-time nullable: true - state: *318 + state: *320 contact_link: description: The contact link of the campaign. type: string @@ -40752,7 +41027,7 @@ paths: headers: Link: *47 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40774,7 +41049,7 @@ paths: operationId: campaigns/create-campaign externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - *89 requestBody: @@ -40875,9 +41150,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *321 examples: - default: &320 + default: &322 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -40926,7 +41201,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40946,7 +41221,7 @@ paths: operationId: campaigns/get-campaign-summary externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - *89 - name: campaign_number @@ -40960,16 +41235,16 @@ paths: description: Response content: application/json: - schema: *319 + schema: *321 examples: - default: *320 + default: *322 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40988,7 +41263,7 @@ paths: operationId: campaigns/update-campaign externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#update-a-campaign parameters: - *89 - name: campaign_number @@ -41039,7 +41314,7 @@ paths: type: string format: uri nullable: true - state: *318 + state: *320 examples: default: value: @@ -41049,9 +41324,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *321 examples: - default: *320 + default: *322 '400': description: Bad Request content: @@ -41063,7 +41338,7 @@ paths: content: application/json: schema: *3 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41082,7 +41357,7 @@ paths: operationId: campaigns/delete-campaign externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - *89 - name: campaign_number @@ -41095,7 +41370,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41105,7 +41380,7 @@ paths: get: summary: List code scanning alerts for an organization description: |- - Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an owner or security manager for the organization to use this endpoint. @@ -41115,11 +41390,11 @@ paths: operationId: code-scanning/list-alerts-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *89 - - *321 - - *322 + - *323 + - *324 - *110 - *111 - *19 @@ -41130,7 +41405,7 @@ paths: be returned. in: query required: false - schema: *323 + schema: *325 - name: sort description: The property by which to sort the results. in: query @@ -41146,7 +41421,7 @@ paths: be returned. in: query required: false - schema: &551 + schema: &553 type: string description: Severity of a code scanning alert. enum: @@ -41172,13 +41447,13 @@ paths: application/json: schema: type: array - items: *324 + items: *326 examples: - default: *325 + default: *327 headers: Link: *47 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41198,7 +41473,7 @@ paths: operationId: code-security/get-configurations-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - *89 - name: target_type @@ -41214,7 +41489,7 @@ paths: - name: per_page in: query description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." required: false schema: type: integer @@ -41304,7 +41579,7 @@ paths: operationId: code-security/create-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#create-a-code-security-configuration parameters: - *89 requestBody: @@ -41550,7 +41825,7 @@ paths: application/json: schema: *116 examples: - default: *326 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41570,7 +41845,7 @@ paths: operationId: code-security/get-default-configurations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-default-code-security-configurations parameters: - *89 responses: @@ -41578,9 +41853,9 @@ paths: description: Response content: application/json: - schema: *327 + schema: *329 examples: - default: *328 + default: *330 '304': *37 '403': *29 '404': *6 @@ -41604,7 +41879,7 @@ paths: operationId: code-security/detach-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#detach-configurations-from-repositories parameters: - *89 requestBody: @@ -41614,6 +41889,8 @@ paths: schema: type: object additionalProperties: false + required: + - selected_repository_ids properties: selected_repository_ids: type: array @@ -41656,7 +41933,7 @@ paths: operationId: code-security/get-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-a-code-security-configuration parameters: - *89 - *118 @@ -41667,7 +41944,7 @@ paths: application/json: schema: *116 examples: - default: *326 + default: *328 '304': *37 '403': *29 '404': *6 @@ -41689,7 +41966,7 @@ paths: operationId: code-security/update-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#update-a-code-security-configuration parameters: - *89 - *118 @@ -41969,7 +42246,7 @@ paths: operationId: code-security/delete-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#delete-a-code-security-configuration parameters: - *89 - *118 @@ -42000,7 +42277,7 @@ paths: operationId: code-security/attach-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - *89 - *118 @@ -42064,7 +42341,7 @@ paths: operationId: code-security/set-configuration-as-default externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - *89 - *118 @@ -42112,7 +42389,7 @@ paths: default: value: default_for_new_repos: all - configuration: *326 + configuration: *328 '403': *29 '404': *6 x-github: @@ -42134,13 +42411,13 @@ paths: operationId: code-security/get-repositories-for-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - *89 - *118 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -42165,13 +42442,13 @@ paths: application/json: schema: type: array - items: *329 + items: *331 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *330 + repository: *332 '403': *29 '404': *6 x-github: @@ -42191,7 +42468,7 @@ paths: operationId: codespaces/list-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#list-codespaces-for-the-organization parameters: - *17 - *19 @@ -42211,7 +42488,7 @@ paths: type: integer codespaces: type: array - items: &393 + items: &395 type: object title: Codespace description: A codespace. @@ -42236,12 +42513,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *288 + repository: *290 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &583 + properties: &585 name: type: string description: The name of the machine. @@ -42283,7 +42560,7 @@ paths: - ready - in_progress nullable: true - required: &584 + required: &586 - name - display_name - operating_system @@ -42488,7 +42765,7 @@ paths: - pulls_url - recent_folders examples: - default: &394 + default: &396 value: total_count: 3 codespaces: @@ -42918,7 +43195,7 @@ paths: operationId: codespaces/set-codespaces-access externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - *89 deprecated: true @@ -42977,7 +43254,7 @@ paths: Codespaces for the specified users will be billed to the organization. To use this endpoint, the access settings for the organization must be set to `selected_members`. - For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -42985,7 +43262,7 @@ paths: operationId: codespaces/set-codespaces-access-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - *89 deprecated: true @@ -43031,7 +43308,7 @@ paths: Codespaces for the specified users will no longer be billed to the organization. To use this endpoint, the access settings for the organization must be set to `selected_members`. - For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -43039,7 +43316,7 @@ paths: operationId: codespaces/delete-codespaces-access-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - *89 @@ -43092,7 +43369,7 @@ paths: operationId: codespaces/list-org-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-organization-secrets parameters: - *89 - *17 @@ -43112,7 +43389,7 @@ paths: type: integer secrets: type: array - items: &331 + items: &333 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -43151,7 +43428,7 @@ paths: - updated_at - visibility examples: - default: &585 + default: &587 value: total_count: 2 secrets: @@ -43181,7 +43458,7 @@ paths: operationId: codespaces/get-org-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - *89 responses: @@ -43189,7 +43466,7 @@ paths: description: Response content: application/json: - schema: &586 + schema: &588 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -43218,7 +43495,7 @@ paths: - key_id - key examples: - default: &587 + default: &589 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -43239,18 +43516,18 @@ paths: operationId: codespaces/get-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *89 - - *298 + - *300 responses: '200': description: Response content: application/json: - schema: *331 + schema: *333 examples: - default: &589 + default: &591 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -43267,7 +43544,7 @@ paths: summary: Create or update an organization secret description: |- Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -43275,10 +43552,10 @@ paths: operationId: codespaces/create-or-update-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *89 - - *298 + - *300 requestBody: required: true content: @@ -43290,7 +43567,7 @@ paths: type: string description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public - key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -43311,9 +43588,9 @@ paths: secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) + an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -43333,7 +43610,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -43357,10 +43634,10 @@ paths: operationId: codespaces/delete-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *89 - - *298 + - *300 responses: '204': description: Response @@ -43383,10 +43660,10 @@ paths: operationId: codespaces/list-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *89 - - *298 + - *300 - *19 - *17 responses: @@ -43404,9 +43681,9 @@ paths: type: integer repositories: type: array - items: *288 + items: *290 examples: - default: *302 + default: *304 '404': *6 x-github: githubCloudOnly: false @@ -43418,7 +43695,7 @@ paths: description: |- Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -43426,10 +43703,10 @@ paths: operationId: codespaces/set-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *89 - - *298 + - *300 requestBody: required: true content: @@ -43443,8 +43720,8 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization - secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) + secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -43470,17 +43747,17 @@ paths: put: summary: Add selected repository to an organization secret description: |- - Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/add-selected-repo-to-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *89 - - *298 + - *300 - name: repository_id in: path required: true @@ -43503,7 +43780,7 @@ paths: description: |- Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -43511,10 +43788,10 @@ paths: operationId: codespaces/remove-selected-repo-from-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *89 - - *298 + - *300 - name: repository_id in: path required: true @@ -43541,7 +43818,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -43551,7 +43828,7 @@ paths: operationId: copilot/get-copilot-organization-details externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - *89 responses: @@ -43684,7 +43961,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -43692,13 +43969,13 @@ paths: operationId: copilot/list-copilot-seats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - *89 - *19 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -43717,9 +43994,9 @@ paths: currently being billed. seats: type: array - items: *149 + items: *151 examples: - default: *150 + default: *152 headers: Link: *47 '500': *40 @@ -43739,11 +44016,11 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." - For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response contains the total number of new seats that were created and existing seats that were refreshed. @@ -43753,7 +44030,7 @@ paths: operationId: copilot/add-copilot-seats-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - *89 requestBody: @@ -43819,7 +44096,7 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. @@ -43831,7 +44108,7 @@ paths: operationId: copilot/cancel-copilot-seat-assignment-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - *89 requestBody: @@ -43897,11 +44174,11 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." - For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response contains the total number of new seats that were created and existing seats that were refreshed. @@ -43911,7 +44188,7 @@ paths: operationId: copilot/add-copilot-seats-for-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - *89 requestBody: @@ -43976,7 +44253,7 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. @@ -43988,7 +44265,7 @@ paths: operationId: copilot/cancel-copilot-seat-assignment-for-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - *89 requestBody: @@ -44066,7 +44343,7 @@ paths: operationId: copilot/get-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization parameters: - *89 responses: @@ -44131,7 +44408,7 @@ paths: operationId: copilot/set-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization parameters: - *89 requestBody: @@ -44186,7 +44463,7 @@ paths: operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization parameters: - *89 - *17 @@ -44203,12 +44480,12 @@ paths: type: integer repositories: type: array - items: *288 + items: *290 required: - total_count - repositories examples: - default: *332 + default: *334 '500': *40 '401': *25 '403': *29 @@ -44235,7 +44512,7 @@ paths: operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization parameters: - *89 requestBody: @@ -44291,10 +44568,10 @@ paths: operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *89 - - *282 + - *284 responses: '204': description: No Content @@ -44325,10 +44602,10 @@ paths: operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *89 - - *282 + - *284 responses: '204': description: No Content @@ -44351,7 +44628,7 @@ paths: Gets information about an organization's Copilot content exclusion path rules. To configure these settings, go to the organization's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." Organization owners can view details about Copilot content exclusion rules for the organization. @@ -44365,7 +44642,7 @@ paths: operationId: copilot/copilot-content-exclusion-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization parameters: - *89 responses: @@ -44404,7 +44681,7 @@ paths: Sets Copilot content exclusion path rules for an organization. To configure these settings, go to the organization's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." Organization owners can set Copilot content exclusion rules for the organization. @@ -44418,7 +44695,7 @@ paths: operationId: copilot/set-copilot-content-exclusion-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization parameters: - *89 requestBody: @@ -44476,7 +44753,7 @@ paths: '401': *25 '403': *29 '404': *6 - '413': *333 + '413': *335 '422': *7 x-github: githubCloudOnly: @@ -44505,7 +44782,7 @@ paths: operationId: copilot/copilot-metrics-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - *89 - name: since @@ -44527,7 +44804,7 @@ paths: - *19 - name: per_page description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -44539,13 +44816,13 @@ paths: application/json: schema: type: array - items: *211 + items: *213 examples: - default: *212 + default: *214 '500': *40 '403': *29 '404': *6 - '422': *213 + '422': *215 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44563,13 +44840,13 @@ paths: Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). tags: - copilot operationId: copilot/copilot-organization-one-day-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day parameters: - *89 - *125 @@ -44602,13 +44879,13 @@ paths: Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). tags: - copilot operationId: copilot/copilot-organization-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics parameters: - *89 responses: @@ -44639,13 +44916,13 @@ paths: Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). tags: - copilot operationId: copilot/copilot-organization-users-one-day-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day parameters: - *89 - *125 @@ -44678,13 +44955,13 @@ paths: Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). tags: - copilot operationId: copilot/copilot-organization-users-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics parameters: - *89 responses: @@ -44707,7 +44984,7 @@ paths: get: summary: List SAML SSO authorizations for an organization description: |- - Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on). + Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest/articles/about-authentication-with-saml-single-sign-on). The authenticated user must be an organization owner to use this endpoint. @@ -44717,7 +44994,7 @@ paths: operationId: orgs/list-saml-sso-authorizations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - *89 - *17 @@ -44861,7 +45138,7 @@ paths: operationId: orgs/remove-saml-sso-authorization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - *89 - name: credential_id @@ -44882,7 +45159,7 @@ paths: get: summary: List custom repository roles in an organization description: |- - List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. @@ -44892,7 +45169,7 @@ paths: operationId: orgs/list-custom-repo-roles externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - *89 responses: @@ -44909,7 +45186,7 @@ paths: type: integer custom_roles: type: array - items: *334 + items: *336 examples: default: value: @@ -44984,7 +45261,7 @@ paths: post: summary: Create a custom repository role description: |- - Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -44994,14 +45271,14 @@ paths: operationId: orgs/create-custom-repo-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role parameters: - *89 requestBody: required: true content: application/json: - schema: &336 + schema: &338 type: object properties: name: @@ -45042,9 +45319,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: *335 + default: *337 '422': *15 '404': *6 x-github: @@ -45056,7 +45333,7 @@ paths: get: summary: Get a custom repository role description: |- - Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. @@ -45066,18 +45343,18 @@ paths: operationId: orgs/get-custom-repo-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#get-a-custom-repository-role parameters: - *89 - - *145 + - *147 responses: '200': description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: *335 + default: *337 '404': *6 x-github: githubCloudOnly: true @@ -45087,7 +45364,7 @@ paths: patch: summary: Update a custom repository role description: |- - Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -45097,15 +45374,15 @@ paths: operationId: orgs/update-custom-repo-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role parameters: - *89 - - *145 + - *147 requestBody: required: true content: application/json: - schema: &337 + schema: &339 type: object properties: name: @@ -45143,9 +45420,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: *335 + default: *337 '422': *15 '404': *6 x-github: @@ -45157,7 +45434,7 @@ paths: summary: Delete a custom repository role description: |- Deletes a custom role from an organization. Once the custom role has been deleted, any - user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -45167,10 +45444,10 @@ paths: operationId: orgs/delete-custom-repo-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - *89 - - *145 + - *147 responses: '204': description: Response @@ -45184,9 +45461,9 @@ paths: summary: Closing down - Create a custom role description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. - Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -45196,14 +45473,14 @@ paths: operationId: orgs/create-custom-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - *89 requestBody: required: true content: application/json: - schema: *336 + schema: *338 examples: default: value: @@ -45217,9 +45494,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: *335 + default: *337 '422': *15 '404': *6 x-github: @@ -45235,9 +45512,9 @@ paths: summary: Closing down - Get a custom role description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. - Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. @@ -45247,18 +45524,18 @@ paths: operationId: orgs/get-custom-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - *89 - - *145 + - *147 responses: '200': description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: *335 + default: *337 '404': *6 x-github: githubCloudOnly: true @@ -45272,9 +45549,9 @@ paths: summary: Closing down - Update a custom role description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. - Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -45284,15 +45561,15 @@ paths: operationId: orgs/update-custom-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - *89 - - *145 + - *147 requestBody: required: true content: application/json: - schema: *337 + schema: *339 examples: default: value: @@ -45307,9 +45584,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *336 examples: - default: *335 + default: *337 '422': *15 '404': *6 x-github: @@ -45324,10 +45601,10 @@ paths: summary: Closing down - Delete a custom role description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. Deletes a custom role from an organization. Once the custom role has been deleted, any - user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -45337,10 +45614,10 @@ paths: operationId: orgs/delete-custom-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - *89 - - *145 + - *147 responses: '204': description: Response @@ -45366,15 +45643,15 @@ paths: operationId: dependabot/list-alerts-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *89 - - *338 - - *339 - *340 - *341 - *342 - *343 + - *344 + - *345 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -45404,7 +45681,7 @@ paths: enum: - patch - deployment - - *344 + - *346 - name: runtime_risk in: query description: |- @@ -45413,8 +45690,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *345 - - *346 + - *347 + - *348 - *112 - *110 - *111 @@ -45426,9 +45703,9 @@ paths: application/json: schema: type: array - items: *347 + items: *349 examples: - default: *348 + default: *350 '304': *37 '400': *14 '403': *29 @@ -45452,7 +45729,7 @@ paths: operationId: dependabot/repository-access-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - *89 - name: page @@ -45477,104 +45754,9 @@ paths: description: Response content: application/json: - schema: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able - to access in an organization - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot - updates. - enum: - - public - - internal - example: internal - nullable: true - accessible_repositories: - type: array - items: - title: Simple Repository - description: A GitHub repository. - type: object - properties: *349 - required: *350 - nullable: true - additionalProperties: false + schema: *351 examples: - default: - value: - default_level: public - accessible_repositories: - - id: 123456 - node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= - name: example-repo - full_name: octocat/example-repo - owner: - name: octocat - email: octo@github.com - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://avatars.githubusercontent.com/u/1?v=4 - gravatar_id: 1 - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat/example-repo - 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 - starred_at: '"2020-07-09T00:17:55Z"' - user_view_type: default - private: false - html_url: https://github.com/octocat/example-repo - description: This is an example repository. - fork: false - url: https://api.github.com/repos/octocat/example-repo - archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} - commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} - compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/example-repo/contributors - deployments_url: https://api.github.com/repos/octocat/example-repo/deployments - downloads_url: https://api.github.com/repos/octocat/example-repo/downloads - events_url: https://api.github.com/repos/octocat/example-repo/events - forks_url: https://api.github.com/repos/octocat/example-repo/forks - git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} - keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} - languages_url: https://api.github.com/repos/octocat/example-repo/languages - merges_url: https://api.github.com/repos/octocat/example-repo/merges - milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} - releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers - statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/example-repo/subscription - tags_url: https://api.github.com/repos/octocat/example-repo/tags - teams_url: https://api.github.com/repos/octocat/example-repo/teams - trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + default: *352 '403': *29 '404': *6 x-github: @@ -45603,7 +45785,7 @@ paths: operationId: dependabot/update-repository-access-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - *89 requestBody: @@ -45669,7 +45851,7 @@ paths: operationId: dependabot/set-repository-access-default-level externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - *89 requestBody: @@ -45717,7 +45899,7 @@ paths: operationId: dependabot/list-org-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-organization-secrets parameters: - *89 - *17 @@ -45737,7 +45919,7 @@ paths: type: integer secrets: type: array - items: &351 + items: &353 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -45806,7 +45988,7 @@ paths: operationId: dependabot/get-org-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-public-key parameters: - *89 responses: @@ -45814,7 +45996,7 @@ paths: description: Response content: application/json: - schema: &620 + schema: &622 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -45831,7 +46013,7 @@ paths: - key_id - key examples: - default: &621 + default: &623 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -45852,16 +46034,16 @@ paths: operationId: dependabot/get-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-secret parameters: - *89 - - *298 + - *300 responses: '200': description: Response content: application/json: - schema: *351 + schema: *353 examples: default: value: @@ -45879,7 +46061,7 @@ paths: summary: Create or update an organization secret description: |- Creates or updates an organization secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -45887,10 +46069,10 @@ paths: operationId: dependabot/create-or-update-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *89 - - *298 + - *300 requestBody: required: true content: @@ -45902,7 +46084,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public - key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -45923,9 +46105,9 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: anyOf: @@ -45947,7 +46129,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -45969,10 +46151,10 @@ paths: operationId: dependabot/delete-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-an-organization-secret parameters: - *89 - - *298 + - *300 responses: '204': description: Response @@ -45994,10 +46176,10 @@ paths: operationId: dependabot/list-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *89 - - *298 + - *300 - *19 - *17 responses: @@ -46015,9 +46197,9 @@ paths: type: integer repositories: type: array - items: *288 + items: *290 examples: - default: *302 + default: *304 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46028,7 +46210,7 @@ paths: description: |- Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -46036,10 +46218,10 @@ paths: operationId: dependabot/set-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *89 - - *298 + - *300 requestBody: required: true content: @@ -46053,8 +46235,8 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization - secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -46079,7 +46261,7 @@ paths: description: |- Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or - update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -46087,10 +46269,10 @@ paths: operationId: dependabot/add-selected-repo-to-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *89 - - *298 + - *300 - name: repository_id in: path required: true @@ -46111,7 +46293,7 @@ paths: description: |- Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -46119,10 +46301,10 @@ paths: operationId: dependabot/remove-selected-repo-from-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *89 - - *298 + - *300 - name: repository_id in: path required: true @@ -46151,7 +46333,7 @@ paths: operationId: code-scanning/list-org-dismissal-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -46159,7 +46341,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *89 - - &630 + - &632 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -46167,7 +46349,7 @@ paths: required: false schema: type: string - - &631 + - &633 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -46175,7 +46357,7 @@ paths: required: false schema: type: string - - &632 + - &634 name: time_period description: |- The time period to filter by. @@ -46191,7 +46373,7 @@ paths: - week - month default: month - - &633 + - &635 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -46206,7 +46388,7 @@ paths: - denied - all default: all - - *314 + - *316 - *17 - *19 responses: @@ -46216,7 +46398,7 @@ paths: application/json: schema: type: array - items: &634 + items: &636 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -46322,7 +46504,7 @@ paths: type: array description: The responses to the dismissal request. nullable: true - items: &353 + items: &355 title: Dismissal request response description: A response made by a requester to dismiss the request. @@ -46372,7 +46554,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &635 + default: &637 value: - id: 21 number: 42 @@ -46452,7 +46634,7 @@ paths: operationId: dependabot/list-dismissal-requests-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-an-organization x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -46460,11 +46642,11 @@ paths: subcategory: alert-dismissal-requests parameters: - *89 - - *314 + - *316 - *105 - *106 - *107 - - *352 + - *354 - *17 - *19 responses: @@ -46474,7 +46656,7 @@ paths: application/json: schema: type: array - items: &636 + items: &638 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -46580,7 +46762,7 @@ paths: type: array description: The responses to the dismissal request. nullable: true - items: *353 + items: *355 url: type: string format: uri @@ -46591,7 +46773,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &637 + default: &639 value: - id: 21 number: 42 @@ -46671,7 +46853,7 @@ paths: operationId: secret-scanning/list-org-dismissal-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -46679,11 +46861,11 @@ paths: subcategory: alert-dismissal-requests parameters: - *89 - - *314 + - *316 - *105 - *106 - *107 - - *352 + - *354 - *17 - *19 responses: @@ -46693,9 +46875,9 @@ paths: application/json: schema: type: array - items: *354 + items: *356 examples: - default: *355 + default: *357 '404': *6 '403': *29 '500': *40 @@ -46711,7 +46893,7 @@ paths: operationId: packages/list-docker-migration-conflicting-packages-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - *89 responses: @@ -46721,7 +46903,7 @@ paths: application/json: schema: type: array - items: &404 + items: &406 title: Package description: A software package type: object @@ -46771,8 +46953,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *356 - required: *357 + properties: *358 + required: *359 nullable: true created_at: type: string @@ -46791,7 +46973,7 @@ paths: - created_at - updated_at examples: - default: &405 + default: &407 value: - id: 197 name: hello_docker @@ -46867,7 +47049,7 @@ paths: operationId: activity/list-public-org-events externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-organization-events parameters: - *89 - *17 @@ -46879,7 +47061,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: 200-response: value: @@ -46944,13 +47126,13 @@ paths: description: |- Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. - You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/external-idp-group-info-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#get-an-external-group parameters: - *89 - name: group_id @@ -46961,14 +47143,14 @@ paths: type: integer - name: per_page description: The number of results per page for the "members" array (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 - name: page description: The page number of the "members" array results to fetch. For - more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -46978,7 +47160,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &477 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -47059,7 +47241,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &476 + default: &478 value: group_id: '123' group_name: Octocat admins @@ -47089,13 +47271,13 @@ paths: description: |- Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." - You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/list-external-idp-groups-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#list-external-groups-available-to-an-organization parameters: - *89 - *17 @@ -47114,7 +47296,7 @@ paths: description: Response content: application/json: - schema: &472 + schema: &474 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -47151,7 +47333,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &473 + default: &475 value: groups: - group_id: '123' @@ -47178,13 +47360,13 @@ paths: 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. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). tags: - orgs operationId: orgs/list-failed-invitations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-failed-organization-invitations parameters: - *89 - *17 @@ -47196,7 +47378,7 @@ paths: application/json: schema: type: array - items: &382 + items: &384 title: Organization Invitation description: Organization Invitation type: object @@ -47243,7 +47425,7 @@ paths: - invitation_teams_url - node_id examples: - default: &383 + default: &385 value: - id: 1 login: monalisa @@ -47288,9 +47470,9 @@ paths: summary: Closing down - List fine-grained permissions for an organization description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. - Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization. @@ -47300,7 +47482,7 @@ paths: operationId: orgs/list-fine-grained-permissions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - *89 responses: @@ -47310,7 +47492,7 @@ paths: application/json: schema: type: array - items: &438 + items: &440 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -47324,7 +47506,7 @@ paths: - name - description examples: - default: &439 + default: &441 value: - name: add_assignee description: Assign or remove a user @@ -47353,7 +47535,7 @@ paths: operationId: orgs/list-webhooks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#list-organization-webhooks parameters: - *89 - *17 @@ -47365,7 +47547,7 @@ paths: application/json: schema: type: array - items: &358 + items: &360 title: Org Hook description: Org Hook type: object @@ -47472,7 +47654,7 @@ paths: operationId: orgs/create-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#create-an-organization-webhook parameters: - *89 requestBody: @@ -47503,7 +47685,7 @@ paths: - url events: type: array - description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) + description: Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. default: @@ -47534,9 +47716,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *360 examples: - default: &359 + default: &361 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -47578,10 +47760,10 @@ paths: operationId: orgs/get-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-an-organization-webhook parameters: - *89 - - &360 + - &362 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -47594,9 +47776,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *360 examples: - default: *359 + default: *361 '404': *6 x-github: githubCloudOnly: false @@ -47615,10 +47797,10 @@ paths: operationId: orgs/update-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#update-an-organization-webhook parameters: - *89 - - *360 + - *362 requestBody: required: false content: @@ -47638,7 +47820,7 @@ paths: - url events: type: array - description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) + description: Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. default: - push @@ -47663,7 +47845,7 @@ paths: description: Response content: application/json: - schema: *358 + schema: *360 examples: default: value: @@ -47700,10 +47882,10 @@ paths: operationId: orgs/delete-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *89 - - *360 + - *362 responses: '204': description: Response @@ -47726,10 +47908,10 @@ paths: operationId: orgs/get-webhook-config-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *89 - - *360 + - *362 responses: '200': description: Response @@ -47755,10 +47937,10 @@ paths: operationId: orgs/update-webhook-config-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *89 - - *360 + - *362 requestBody: required: false content: @@ -47804,13 +47986,13 @@ paths: operationId: orgs/list-webhook-deliveries externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *89 - - *360 - - *17 - - *361 - *362 + - *17 + - *363 + - *364 responses: '200': description: Response @@ -47818,9 +48000,9 @@ paths: application/json: schema: type: array - items: *363 + items: *365 examples: - default: *364 + default: *366 '400': *14 '422': *15 x-github: @@ -47841,19 +48023,19 @@ paths: operationId: orgs/get-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *89 - - *360 + - *362 - *16 responses: '200': description: Response content: application/json: - schema: *365 + schema: *367 examples: - default: *366 + default: *368 '400': *14 '422': *15 x-github: @@ -47874,10 +48056,10 @@ paths: operationId: orgs/redeliver-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *89 - - *360 + - *362 - *16 responses: '202': *39 @@ -47901,10 +48083,10 @@ paths: operationId: orgs/ping-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *89 - - *360 + - *362 responses: '204': description: Response @@ -47924,10 +48106,10 @@ paths: operationId: api-insights/get-route-stats-by-actor externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *89 - - &371 + - &373 name: actor_type in: path description: The type of the actor @@ -47940,14 +48122,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &372 + - &374 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &367 + - &369 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -47955,7 +48137,7 @@ paths: required: true schema: type: string - - &368 + - &370 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -48046,15 +48228,15 @@ paths: operationId: api-insights/get-subject-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-subject-stats parameters: - *89 - - *367 - - *368 + - *369 + - *370 - *19 - *17 - *112 - - &377 + - &379 name: sort description: The property to sort the results by. in: query @@ -48129,17 +48311,17 @@ paths: operationId: api-insights/get-summary-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats parameters: - *89 - - *367 - - *368 + - *369 + - *370 responses: '200': description: Response content: application/json: - schema: &369 + schema: &371 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -48155,7 +48337,7 @@ paths: type: integer format: int64 examples: - default: &370 + default: &372 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -48173,26 +48355,26 @@ paths: operationId: api-insights/get-summary-stats-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *89 - - &373 + - &375 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *367 - - *368 + - *369 + - *370 responses: '200': description: Response content: application/json: - schema: *369 + schema: *371 examples: - default: *370 + default: *372 x-github: enabledForGitHubApps: true category: orgs @@ -48208,21 +48390,21 @@ paths: operationId: api-insights/get-summary-stats-by-actor externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *89 - - *367 - - *368 - - *371 - - *372 + - *369 + - *370 + - *373 + - *374 responses: '200': description: Response content: application/json: - schema: *369 + schema: *371 examples: - default: *370 + default: *372 x-github: enabledForGitHubApps: true category: orgs @@ -48237,12 +48419,12 @@ paths: operationId: api-insights/get-time-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats parameters: - *89 - - *367 - - *368 - - &374 + - *369 + - *370 + - &376 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -48255,7 +48437,7 @@ paths: description: Response content: application/json: - schema: &375 + schema: &377 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -48271,7 +48453,7 @@ paths: type: integer format: int64 examples: - default: &376 + default: &378 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -48305,21 +48487,21 @@ paths: operationId: api-insights/get-time-stats-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats-by-user parameters: - *89 - - *373 - - *367 - - *368 - - *374 + - *375 + - *369 + - *370 + - *376 responses: '200': description: Response content: application/json: - schema: *375 + schema: *377 examples: - default: *376 + default: *378 x-github: enabledForGitHubApps: true category: orgs @@ -48334,22 +48516,22 @@ paths: operationId: api-insights/get-time-stats-by-actor externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *89 - - *371 - - *372 - - *367 - - *368 + - *373 - *374 + - *369 + - *370 + - *376 responses: '200': description: Response content: application/json: - schema: *375 + schema: *377 examples: - default: *376 + default: *378 x-github: enabledForGitHubApps: true category: orgs @@ -48364,16 +48546,16 @@ paths: operationId: api-insights/get-user-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-user-stats parameters: - *89 - - *373 - - *367 - - *368 + - *375 + - *369 + - *370 - *19 - *17 - *112 - - *377 + - *379 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -48438,13 +48620,13 @@ paths: description: |- Enables an authenticated GitHub App to find the organization's installation information. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-org-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - *89 responses: @@ -48454,7 +48636,7 @@ paths: application/json: schema: *22 examples: - default: *378 + default: *380 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -48475,7 +48657,7 @@ paths: operationId: orgs/list-app-installations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - *89 - *17 @@ -48564,7 +48746,7 @@ paths: operationId: interactions/get-restrictions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - *89 responses: @@ -48574,12 +48756,12 @@ paths: application/json: schema: anyOf: - - &380 + - &382 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &379 + limit: &381 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -48604,7 +48786,7 @@ paths: properties: {} additionalProperties: false examples: - default: &381 + default: &383 value: limit: collaborators_only origin: organization @@ -48626,20 +48808,20 @@ paths: operationId: interactions/set-restrictions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - *89 requestBody: required: true content: application/json: - schema: &668 + schema: &670 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *379 + limit: *381 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -48663,9 +48845,9 @@ paths: description: Response content: application/json: - schema: *380 + schema: *382 examples: - default: *381 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -48681,7 +48863,7 @@ paths: operationId: interactions/remove-restrictions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - *89 responses: @@ -48701,13 +48883,13 @@ paths: `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). tags: - orgs operationId: orgs/list-pending-invitations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-pending-organization-invitations parameters: - *89 - *17 @@ -48743,9 +48925,9 @@ paths: application/json: schema: type: array - items: *382 + items: *384 examples: - default: *383 + default: *385 headers: Link: *47 '404': *6 @@ -48759,15 +48941,15 @@ paths: 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. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). - 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. + 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. tags: - orgs operationId: orgs/create-invitation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#create-an-organization-invitation parameters: - *89 requestBody: @@ -48823,7 +49005,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *384 examples: default: value: @@ -48869,18 +49051,18 @@ paths: description: |- Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/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/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#cancel-an-organization-invitation parameters: - *89 - - &384 + - &386 name: invitation_id description: The unique identifier of the invitation. in: path @@ -48905,16 +49087,16 @@ paths: List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). tags: - orgs operationId: orgs/list-invitation-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-invitation-teams parameters: - *89 - - *384 + - *386 - *17 - *19 responses: @@ -48924,9 +49106,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - default: &403 + default: &405 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -48959,7 +49141,7 @@ paths: operationId: orgs/list-issue-fields externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#list-issue-fields-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#list-issue-fields-for-an-organization parameters: - *89 responses: @@ -48969,7 +49151,7 @@ paths: application/json: schema: type: array - items: &385 + items: &387 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -49101,7 +49283,7 @@ paths: description: |- Creates a new issue field for an organization. - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -49110,7 +49292,7 @@ paths: operationId: orgs/create-issue-field externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#create-issue-field-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#create-issue-field-for-an-organization parameters: - *89 requestBody: @@ -49202,9 +49384,9 @@ paths: description: Response content: application/json: - schema: *385 + schema: *387 examples: - default: &386 + default: &388 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -49248,7 +49430,7 @@ paths: description: |- Updates an issue field for an organization. - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -49257,10 +49439,10 @@ paths: operationId: orgs/update-issue-field externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#update-issue-field-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *89 - - &387 + - &389 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -49368,9 +49550,9 @@ paths: description: Response content: application/json: - schema: *385 + schema: *387 examples: - default: *386 + default: *388 '404': *6 '422': *7 x-github: @@ -49383,7 +49565,7 @@ paths: description: |- Deletes an issue field for an organization. - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -49392,10 +49574,10 @@ paths: operationId: orgs/delete-issue-field externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#delete-issue-field-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *89 - - *387 + - *389 responses: '204': *130 '404': *6 @@ -49415,7 +49597,7 @@ paths: operationId: orgs/list-issue-types externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - *89 responses: @@ -49425,7 +49607,7 @@ paths: application/json: schema: type: array - items: *388 + items: *390 examples: default: value: @@ -49452,7 +49634,7 @@ paths: description: |- Create a new issue type for an organization. - You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -49461,7 +49643,7 @@ paths: operationId: orgs/create-issue-type externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - *89 requestBody: @@ -49510,9 +49692,9 @@ paths: description: Response content: application/json: - schema: *388 + schema: *390 examples: - default: &389 + default: &391 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -49533,7 +49715,7 @@ paths: description: |- Updates an issue type for an organization. - You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -49542,10 +49724,10 @@ paths: operationId: orgs/update-issue-type externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *89 - - &390 + - &392 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -49598,9 +49780,9 @@ paths: description: Response content: application/json: - schema: *388 + schema: *390 examples: - default: *389 + default: *391 '404': *6 '422': *7 x-github: @@ -49613,7 +49795,7 @@ paths: description: |- Deletes an issue type for an organization. - You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -49622,10 +49804,10 @@ paths: operationId: orgs/delete-issue-type externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *89 - - *390 + - *392 responses: '204': description: Response @@ -49643,9 +49825,9 @@ paths: List issues in an organization assigned to the authenticated user. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -49656,7 +49838,7 @@ paths: operationId: issues/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - *89 - name: filter @@ -49688,7 +49870,7 @@ paths: - closed - all default: open - - *391 + - *393 - name: type description: Can be the name of an issue type. in: query @@ -49707,7 +49889,7 @@ paths: - comments default: created - *112 - - *234 + - *236 - *17 - *19 responses: @@ -49717,9 +49899,9 @@ paths: application/json: schema: type: array - items: *227 + items: *229 examples: - default: *392 + default: *394 headers: Link: *47 '404': *6 @@ -49739,14 +49921,14 @@ paths: operationId: orgs/list-members externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-members parameters: - *89 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure - 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + 2FA methods](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. in: query required: false @@ -49779,7 +49961,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 '422': *15 @@ -49797,10 +49979,10 @@ paths: operationId: orgs/check-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#check-organization-membership-for-a-user parameters: - *89 - - *146 + - *148 responses: '204': description: Response if requester is an organization member and user is @@ -49832,10 +50014,10 @@ paths: operationId: orgs/remove-member externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-an-organization-member parameters: - *89 - - *146 + - *148 responses: '204': description: Response @@ -49857,12 +50039,12 @@ paths: operationId: codespaces/get-codespaces-for-user-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-a-user-in-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization parameters: - *17 - *19 - *89 - - *146 + - *148 responses: '200': description: Response @@ -49878,9 +50060,9 @@ paths: type: integer codespaces: type: array - items: *393 + items: *395 examples: - default: *394 + default: *396 '304': *37 '500': *40 '401': *25 @@ -49903,11 +50085,11 @@ paths: operationId: codespaces/delete-from-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - *89 - - *146 - - &395 + - *148 + - &397 name: codespace_name in: path required: true @@ -49938,19 +50120,19 @@ paths: operationId: codespaces/stop-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - *89 - - *146 - - *395 + - *148 + - *397 responses: '200': description: Response content: application/json: - schema: *393 + schema: *395 examples: - default: &582 + default: &584 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -50111,7 +50293,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -50121,16 +50303,16 @@ paths: operationId: copilot/get-copilot-seat-details-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - *89 - - *146 + - *148 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *149 + schema: *151 examples: default: value: @@ -50197,16 +50379,16 @@ paths: operationId: orgs/get-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-organization-membership-for-a-user parameters: - *89 - - *146 + - *148 responses: '200': description: Response content: application/json: - schema: &396 + schema: &398 title: Org Membership description: Org Membership type: object @@ -50273,7 +50455,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &397 + response-if-user-has-an-active-admin-membership-with-organization: &399 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -50328,7 +50510,7 @@ paths: description: "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an - email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) + email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user @@ -50343,10 +50525,10 @@ paths: operationId: orgs/set-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#set-organization-membership-for-a-user parameters: - *89 - - *146 + - *148 requestBody: required: false content: @@ -50374,9 +50556,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *398 examples: - response-if-user-already-had-membership-with-organization: *397 + response-if-user-already-had-membership-with-organization: *399 '422': *15 '403': *29 x-github: @@ -50398,10 +50580,10 @@ paths: operationId: orgs/remove-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-organization-membership-for-a-user parameters: - *89 - - *146 + - *148 responses: '204': description: Response @@ -50424,7 +50606,7 @@ paths: operationId: migrations/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#list-organization-migrations parameters: - *89 - *17 @@ -50447,7 +50629,7 @@ paths: application/json: schema: type: array - items: &398 + items: &400 title: Migration description: A migration. type: object @@ -50698,7 +50880,7 @@ paths: operationId: migrations/start-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#start-an-organization-migration parameters: - *89 requestBody: @@ -50776,7 +50958,7 @@ paths: description: Response content: application/json: - schema: *398 + schema: *400 examples: default: value: @@ -50952,10 +51134,10 @@ paths: operationId: migrations/get-status-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#get-an-organization-migration-status parameters: - *89 - - &399 + - &401 name: migration_id description: The unique identifier of the migration. in: path @@ -50982,7 +51164,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *398 + schema: *400 examples: default: value: @@ -51149,10 +51331,10 @@ paths: operationId: migrations/download-archive-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *89 - - *399 + - *401 responses: '302': description: Response @@ -51171,10 +51353,10 @@ paths: operationId: migrations/delete-archive-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *89 - - *399 + - *401 responses: '204': description: Response @@ -51188,18 +51370,18 @@ paths: delete: summary: Unlock an organization repository description: Unlocks a repository that was locked for migration. You should - unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) + unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. tags: - migrations operationId: migrations/unlock-repo-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#unlock-an-organization-repository parameters: - *89 - - *399 - - &837 + - *401 + - &839 name: repo_name description: repo_name parameter in: path @@ -51224,10 +51406,10 @@ paths: operationId: migrations/list-repos-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *89 - - *399 + - *401 - *17 - *19 responses: @@ -51237,9 +51419,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: &410 + default: &412 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -51363,14 +51545,14 @@ paths: get: summary: List organization fine-grained permissions for an organization description: |- - Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -51378,7 +51560,7 @@ paths: operationId: orgs/list-organization-fine-grained-permissions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - *89 responses: @@ -51419,12 +51601,12 @@ paths: get: summary: Get all organization roles for an organization description: |- - Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -51432,7 +51614,7 @@ paths: operationId: orgs/list-org-roles externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - *89 responses: @@ -51450,7 +51632,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &400 + items: &402 title: Organization Role description: Organization roles type: object @@ -51586,7 +51768,7 @@ paths: description: |- Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization and optionally across all repositories in the organization. For - more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To include repository permissions in an organization role, you must also include the `base_role` field, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of @@ -51595,12 +51777,12 @@ paths: permissions apply across all of the repositories in the organization. You do not have to include organization permissions in order to add repository permissions. - See "[List repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. + See "[List repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -51608,7 +51790,7 @@ paths: operationId: orgs/create-custom-organization-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#create-a-custom-organization-role parameters: - *89 requestBody: @@ -51657,7 +51839,7 @@ paths: description: Response content: application/json: - schema: *400 + schema: *402 examples: default: value: @@ -51696,7 +51878,7 @@ paths: delete: summary: Remove all organization roles for a team description: |- - Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -51706,10 +51888,10 @@ paths: operationId: orgs/revoke-all-org-roles-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - *89 - - *220 + - *222 responses: '204': description: Response @@ -51722,7 +51904,7 @@ paths: put: summary: Assign an organization role to a team description: |- - Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -51732,11 +51914,11 @@ paths: operationId: orgs/assign-team-to-org-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - *89 - - *220 - - *145 + - *222 + - *147 responses: '204': description: Response @@ -51753,7 +51935,7 @@ paths: delete: summary: Remove an organization role from a team description: |- - Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -51763,11 +51945,11 @@ paths: operationId: orgs/revoke-org-role-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - *89 - - *220 - - *145 + - *222 + - *147 responses: '204': description: Response @@ -51780,7 +51962,7 @@ paths: delete: summary: Remove all organization roles for a user description: |- - Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -51790,10 +51972,10 @@ paths: operationId: orgs/revoke-all-org-roles-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - *89 - - *146 + - *148 responses: '204': description: Response @@ -51806,7 +51988,7 @@ paths: put: summary: Assign an organization role to a user description: |- - Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -51816,11 +51998,11 @@ paths: operationId: orgs/assign-user-to-org-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - *89 - - *146 - - *145 + - *148 + - *147 responses: '204': description: Response @@ -51838,7 +52020,7 @@ paths: delete: summary: Remove an organization role from a user description: |- - Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -51848,11 +52030,11 @@ paths: operationId: orgs/revoke-org-role-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - *89 - - *146 - - *145 + - *148 + - *147 responses: '204': description: Response @@ -51865,12 +52047,12 @@ paths: get: summary: Get an organization role description: |- - Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -51878,16 +52060,16 @@ paths: operationId: orgs/get-org-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#get-an-organization-role parameters: - *89 - - *145 + - *147 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: default: value: @@ -51924,7 +52106,7 @@ paths: patch: summary: Update a custom organization role description: |- - Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." If the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either previously or as part of the update. @@ -51934,7 +52116,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -51942,10 +52124,10 @@ paths: operationId: orgs/patch-custom-organization-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#update-a-custom-organization-role parameters: - *89 - - *145 + - *147 requestBody: required: true content: @@ -51984,7 +52166,7 @@ paths: description: Response content: application/json: - schema: *400 + schema: *402 examples: default: value: @@ -52022,12 +52204,12 @@ paths: delete: summary: Delete a custom organization role. description: |- - Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -52035,10 +52217,10 @@ paths: operationId: orgs/delete-custom-organization-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - *89 - - *145 + - *147 responses: '204': description: Response @@ -52051,7 +52233,7 @@ paths: get: summary: List teams that are assigned to an organization role description: |- - Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. @@ -52061,10 +52243,10 @@ paths: operationId: orgs/list-org-role-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *89 - - *145 + - *147 - *17 - *19 responses: @@ -52142,8 +52324,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *401 - required: *402 + properties: *403 + required: *404 nullable: true type: description: The ownership type of the team @@ -52175,7 +52357,7 @@ paths: - type - parent examples: - default: *403 + default: *405 headers: Link: *47 '404': @@ -52192,7 +52374,7 @@ paths: get: summary: List users that are assigned to an organization role description: |- - Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. @@ -52202,10 +52384,10 @@ paths: operationId: orgs/list-org-role-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *89 - - *145 + - *147 - *17 - *19 responses: @@ -52233,13 +52415,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &462 + items: &464 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *401 - required: *402 + properties: *403 + required: *404 name: nullable: true type: string @@ -52334,7 +52516,7 @@ paths: - type - url examples: - default: *216 + default: *218 headers: Link: *47 '404': @@ -52356,14 +52538,14 @@ paths: operationId: orgs/list-outside-collaborators externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - *89 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators - with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. in: query required: false @@ -52385,7 +52567,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 x-github: @@ -52399,19 +52581,19 @@ paths: description: When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more - information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest//articles/converting-an-organization-member-to-an-outside-collaborator/)". + information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository - management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." tags: - orgs operationId: orgs/convert-member-to-outside-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - *89 - - *146 + - *148 requestBody: required: false content: @@ -52450,7 +52632,7 @@ paths: description: Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing - repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." '404': *6 x-github: githubCloudOnly: false @@ -52466,10 +52648,10 @@ paths: operationId: orgs/remove-outside-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - *89 - - *146 + - *148 responses: '204': description: Response @@ -52489,7 +52671,7 @@ paths: value: message: You cannot specify an organization member to remove as an outside collaborator. - documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization + documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52501,13 +52683,13 @@ paths: description: |- Lists packages in an organization readable by the user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-an-organization parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry @@ -52527,13 +52709,13 @@ paths: - nuget - container - *89 - - &838 + - &840 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. 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)." + 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)." in: query required: false schema: @@ -52544,14 +52726,14 @@ paths: - internal - name: page description: The page number of the results to fetch. For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -52563,12 +52745,12 @@ paths: application/json: schema: type: array - items: *404 + items: *406 examples: - default: *405 + default: *407 '403': *29 '401': *25 - '400': &840 + '400': &842 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -52582,15 +52764,15 @@ paths: description: |- Gets a specific package in an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-an-organization parameters: - - &406 + - &408 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -52608,7 +52790,7 @@ paths: - docker - nuget - container - - &407 + - &409 name: package_name description: The name of the package. in: path @@ -52621,7 +52803,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *406 examples: default: value: @@ -52663,18 +52845,18 @@ paths: description: |- Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *406 - - *407 + - *408 + - *409 - *89 responses: '204': @@ -52697,18 +52879,18 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *406 - - *407 + - *408 + - *409 - *89 - name: token description: package token @@ -52733,16 +52915,16 @@ paths: description: |- Lists package versions for a package owned by an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *406 - - *407 + - *408 + - *409 - *89 - *19 - *17 @@ -52763,7 +52945,7 @@ paths: application/json: schema: type: array - items: &408 + items: &410 title: Package Version description: A version of a software package type: object @@ -52880,18 +53062,18 @@ paths: description: |- Gets a specific package version in an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *406 - - *407 + - *408 + - *409 - *89 - - &409 + - &411 name: package_version_id description: Unique identifier of the package version. in: path @@ -52903,7 +53085,7 @@ paths: description: Response content: application/json: - schema: *408 + schema: *410 examples: default: value: @@ -52929,20 +53111,20 @@ paths: description: |- Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *406 - - *407 - - *89 + - *408 - *409 + - *89 + - *411 responses: '204': description: Response @@ -52964,20 +53146,20 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, 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)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *406 - - *407 - - *89 + - *408 - *409 + - *89 + - *411 responses: '204': description: Response @@ -53002,12 +53184,12 @@ paths: operationId: orgs/list-pat-grant-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - *89 - *17 - *19 - - &411 + - &413 name: sort description: The property by which to sort the results. in: query @@ -53018,7 +53200,7 @@ paths: - created_at default: created_at - *112 - - &412 + - &414 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -53029,7 +53211,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &413 + - &415 name: repository description: The name of the repository to use to filter the results. in: query @@ -53037,7 +53219,7 @@ paths: schema: type: string example: Hello-World - - &414 + - &416 name: permission description: The permission to use to filter the results. in: query @@ -53045,7 +53227,7 @@ paths: schema: type: string example: issues_read - - &415 + - &417 name: last_used_before 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) @@ -53055,7 +53237,7 @@ paths: schema: type: string format: date-time - - &416 + - &418 name: last_used_after 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) @@ -53065,7 +53247,7 @@ paths: schema: type: string format: date-time - - &417 + - &419 name: token_id description: The ID of the token in: query @@ -53227,7 +53409,7 @@ paths: operationId: orgs/review-pat-grant-requests-in-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - *89 requestBody: @@ -53293,7 +53475,7 @@ paths: operationId: orgs/review-pat-grant-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - *89 - name: pat_request_id @@ -53354,7 +53536,7 @@ paths: operationId: orgs/list-pat-grant-request-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - *89 - name: pat_request_id @@ -53376,9 +53558,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 x-github: @@ -53399,19 +53581,19 @@ paths: operationId: orgs/list-pat-grants externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - *89 - *17 - *19 - - *411 - - *112 - - *412 - *413 + - *112 - *414 - *415 - *416 - *417 + - *418 + - *419 responses: '500': *40 '422': *15 @@ -53558,7 +53740,7 @@ paths: operationId: orgs/update-pat-accesses externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - *89 requestBody: @@ -53618,7 +53800,7 @@ paths: operationId: orgs/update-pat-access externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - *89 - name: pat_id @@ -53670,7 +53852,7 @@ paths: operationId: orgs/list-pat-grant-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - *89 - name: pat_id @@ -53691,9 +53873,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 x-github: @@ -53715,7 +53897,7 @@ paths: operationId: private-registries/list-org-private-registries externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - *89 - *17 @@ -53735,7 +53917,7 @@ paths: type: integer configurations: type: array - items: &418 + items: &420 title: Organization private registry description: Private registry configuration for an organization type: object @@ -53876,7 +54058,7 @@ paths: summary: Create a private registry for an organization description: |2- - Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -53885,7 +54067,7 @@ paths: operationId: private-registries/create-org-private-registry externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - *89 requestBody: @@ -53936,7 +54118,7 @@ paths: encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types. type: string @@ -53961,7 +54143,7 @@ paths: private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry - for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) + for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. type: array @@ -54206,7 +54388,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &419 + org-private-registry-with-selected-visibility: &421 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -54245,7 +54427,7 @@ paths: operationId: private-registries/get-org-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - *89 responses: @@ -54293,18 +54475,18 @@ paths: operationId: private-registries/get-org-private-registry externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *89 - - *298 + - *300 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *418 + schema: *420 examples: - default: *419 + default: *421 '404': *6 x-github: githubCloudOnly: false @@ -54315,7 +54497,7 @@ paths: summary: Update a private registry for an organization description: |2- - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -54324,10 +54506,10 @@ paths: operationId: private-registries/update-org-private-registry externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *89 - - *298 + - *300 requestBody: required: true content: @@ -54376,7 +54558,7 @@ paths: encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. type: string pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" @@ -54501,10 +54683,10 @@ paths: operationId: private-registries/delete-org-private-registry externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *89 - - *298 + - *300 responses: '204': description: Response @@ -54525,7 +54707,7 @@ paths: operationId: projects/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#list-projects-for-organization parameters: - *89 - name: q @@ -54544,7 +54726,7 @@ paths: application/json: schema: type: array - items: &420 + items: &422 title: Projects v2 Project description: A projects v2 project type: object @@ -54614,7 +54796,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &931 + properties: &933 id: type: number description: The unique identifier of the status update. @@ -54662,7 +54844,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &932 + required: &934 - id - node_id - created_at @@ -54687,7 +54869,7 @@ paths: - deleted_at - deleted_by examples: - default: &421 + default: &423 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -54788,9 +54970,9 @@ paths: operationId: projects/get-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#get-project-for-organization parameters: - - &422 + - &424 name: project_number description: The project's number. in: path @@ -54803,9 +54985,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *422 examples: - default: *421 + default: *423 headers: Link: *47 '304': *37 @@ -54825,10 +55007,10 @@ paths: operationId: projects/create-draft-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *89 - - *422 + - *424 requestBody: required: true description: Details of the draft item to create in the project. @@ -54862,7 +55044,7 @@ paths: description: Response content: application/json: - schema: &428 + schema: &430 title: Projects v2 Item description: An item belonging to a project type: object @@ -54875,8 +55057,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *227 - - &599 + - *229 + - &601 title: Pull Request Simple description: Pull Request Simple type: object @@ -54982,8 +55164,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *423 - required: *424 + properties: *425 + required: *426 nullable: true active_lock_reason: type: string @@ -55026,7 +55208,7 @@ paths: items: *4 requested_teams: type: array - items: *317 + items: *319 head: type: object properties: @@ -55076,7 +55258,7 @@ paths: _links: type: object properties: - comments: &425 + comments: &427 title: Link description: Hypermedia Link type: object @@ -55085,13 +55267,13 @@ paths: type: string required: - href - commits: *425 - statuses: *425 - html: *425 - issue: *425 - review_comments: *425 - review_comment: *425 - self: *425 + commits: *427 + statuses: *427 + html: *427 + issue: *427 + review_comments: *427 + review_comment: *427 + self: *427 required: - comments - commits @@ -55101,8 +55283,8 @@ paths: - review_comments - review_comment - self - author_association: *224 - auto_merge: &721 + author_association: *226 + auto_merge: &723 title: Auto merge description: The status of auto merging a pull request. type: object @@ -55204,7 +55386,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &427 + content_type: &429 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -55244,7 +55426,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &429 + draft_issue: &431 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -55316,9 +55498,9 @@ paths: operationId: projects/list-fields-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#list-project-fields-for-organization parameters: - - *422 + - *424 - *89 - *17 - *110 @@ -55330,7 +55512,7 @@ paths: application/json: schema: type: array - items: &426 + items: &428 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -55480,7 +55662,7 @@ paths: - updated_at - project_url examples: - default: &859 + default: &861 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -55608,9 +55790,9 @@ paths: operationId: projects/add-field-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *422 + - *424 - *89 requestBody: required: true @@ -55657,7 +55839,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &860 + items: &862 type: object properties: name: @@ -55694,7 +55876,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &861 + iteration_configuration: &863 type: object description: The configuration for iteration fields. properties: @@ -55744,7 +55926,7 @@ paths: value: name: Due date data_type: date - single_select_field: &862 + single_select_field: &864 summary: Create a single select field value: name: Priority @@ -55771,7 +55953,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &863 + iteration_field: &865 summary: Create an iteration field value: name: Sprint @@ -55795,9 +55977,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *426 + schema: *428 examples: - text_field: &864 + text_field: &866 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -55806,7 +55988,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &865 + number_field: &867 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -55815,7 +55997,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &866 + date_field: &868 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -55824,7 +56006,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &867 + single_select_field: &869 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -55858,7 +56040,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &868 + iteration_field: &870 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -55901,10 +56083,10 @@ paths: operationId: projects/get-field-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization parameters: - - *422 - - &869 + - *424 + - &871 name: field_id description: The unique identifier of the field. in: path @@ -55917,9 +56099,9 @@ paths: description: Response content: application/json: - schema: *426 + schema: *428 examples: - default: &870 + default: &872 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -55973,12 +56155,12 @@ paths: operationId: projects/list-items-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *422 + - *424 - *89 - name: q - description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. in: query required: false @@ -56008,7 +56190,7 @@ paths: application/json: schema: type: array - items: &430 + items: &432 title: Projects v2 Item description: An item belonging to a project type: object @@ -56024,7 +56206,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *427 + content_type: *429 content: type: object additionalProperties: true @@ -56067,7 +56249,7 @@ paths: - updated_at - archived_at examples: - default: &431 + default: &433 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -56762,10 +56944,10 @@ paths: operationId: projects/add-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#add-item-to-organization-owned-project parameters: - *89 - - *422 + - *424 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -56835,22 +57017,22 @@ paths: description: Response content: application/json: - schema: *428 + schema: *430 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *429 + value: *431 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *429 + value: *431 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *429 + value: *431 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *429 + value: *431 '304': *37 '403': *29 '401': *25 @@ -56868,11 +57050,11 @@ paths: operationId: projects/get-org-item externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *422 + - *424 - *89 - - &432 + - &434 name: item_id description: The unique identifier of the project item. in: path @@ -56898,9 +57080,9 @@ paths: description: Response content: application/json: - schema: *430 + schema: *432 examples: - default: *431 + default: *433 headers: Link: *47 '304': *37 @@ -56919,11 +57101,11 @@ paths: operationId: projects/update-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#update-project-item-for-organization parameters: - - *422 + - *424 - *89 - - *432 + - *434 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -56993,13 +57175,13 @@ paths: description: Response content: application/json: - schema: *430 + schema: *432 examples: - text_field: *431 - number_field: *431 - date_field: *431 - single_select_field: *431 - iteration_field: *431 + text_field: *433 + number_field: *433 + date_field: *433 + single_select_field: *433 + iteration_field: *433 '401': *25 '403': *29 '404': *6 @@ -57017,11 +57199,11 @@ paths: operationId: projects/delete-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#delete-project-item-for-organization parameters: - - *422 + - *424 - *89 - - *432 + - *434 responses: '204': description: Response @@ -57042,10 +57224,10 @@ paths: operationId: projects/create-view-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-an-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *89 - - *422 + - *424 requestBody: required: true content: @@ -57067,7 +57249,7 @@ paths: example: board filter: type: string - description: The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + description: The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. example: is:issue is:open visible_fields: @@ -57116,7 +57298,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &851 + schema: &853 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -57214,7 +57396,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &433 + value: &435 value: id: 1 number: 1 @@ -57260,10 +57442,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *433 + value: *435 roadmap_view: summary: Response for creating a roadmap view - value: *433 + value: *435 '304': *37 '403': *29 '401': *25 @@ -57289,11 +57471,11 @@ paths: operationId: projects/list-view-items-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-project-view + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *422 + - *424 - *89 - - &871 + - &873 name: view_number description: The number that identifies the project view. in: path @@ -57325,9 +57507,9 @@ paths: application/json: schema: type: array - items: *430 + items: *432 examples: - default: *431 + default: *433 headers: Link: *47 '304': *37 @@ -57350,7 +57532,7 @@ paths: operationId: orgs/custom-properties-for-repos-get-organization-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - *89 responses: @@ -57360,9 +57542,9 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *160 + default: *162 '403': *29 '404': *6 x-github: @@ -57387,7 +57569,7 @@ paths: operationId: orgs/custom-properties-for-repos-create-or-update-organization-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - *89 requestBody: @@ -57400,7 +57582,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *159 + items: *161 minItems: 1 maxItems: 100 required: @@ -57430,9 +57612,9 @@ paths: application/json: schema: type: array - items: *159 + items: *161 examples: - default: *160 + default: *162 '403': *29 '404': *6 x-github: @@ -57451,18 +57633,18 @@ paths: operationId: orgs/custom-properties-for-repos-get-organization-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *89 - - *156 + - *158 responses: '200': description: Response content: application/json: - schema: *159 + schema: *161 examples: - default: *161 + default: *163 '403': *29 '404': *6 x-github: @@ -57483,15 +57665,15 @@ paths: operationId: orgs/custom-properties-for-repos-create-or-update-organization-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *89 - - *156 + - *158 requestBody: required: true content: application/json: - schema: *434 + schema: *436 examples: default: value: @@ -57507,9 +57689,9 @@ paths: description: Response content: application/json: - schema: *159 + schema: *161 examples: - default: *161 + default: *163 '403': *29 '404': *6 x-github: @@ -57530,10 +57712,10 @@ paths: operationId: orgs/custom-properties-for-repos-delete-organization-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *89 - - *156 + - *158 responses: '204': *130 '403': *29 @@ -57554,7 +57736,7 @@ paths: operationId: orgs/custom-properties-for-repos-get-organization-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - *89 - *17 @@ -57564,8 +57746,8 @@ paths: one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)" + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest/articles/searching-for-repositories/)" for a detailed list of qualifiers. in: query required: false @@ -57594,7 +57776,7 @@ paths: example: octocat/Hello-World properties: type: array - items: *158 + items: *160 description: List of custom property names and associated values required: - repository_id @@ -57641,7 +57823,7 @@ paths: operationId: orgs/custom-properties-for-repos-create-or-update-organization-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - *89 requestBody: @@ -57663,7 +57845,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *158 + items: *160 required: - repository_names - properties @@ -57702,7 +57884,7 @@ paths: operationId: orgs/list-public-members externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-public-organization-members parameters: - *89 - *17 @@ -57716,7 +57898,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 x-github: @@ -57733,10 +57915,10 @@ paths: operationId: orgs/check-public-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - *89 - - *146 + - *148 responses: '204': description: Response if user is a public member @@ -57752,16 +57934,16 @@ paths: description: |- The user can publicize their own membership. (A user cannot publicize the membership for another user.) - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - orgs operationId: orgs/set-public-membership-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - *89 - - *146 + - *148 responses: '204': description: Response @@ -57780,10 +57962,10 @@ paths: operationId: orgs/remove-public-membership-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - *89 - - *146 + - *148 responses: '204': description: Response @@ -57799,13 +57981,13 @@ paths: Lists repositories for the specified organization. > [!NOTE] - > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." tags: - repos operationId: repos/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-organization-repositories parameters: - *89 - name: type @@ -57854,9 +58036,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 x-github: @@ -57875,7 +58057,7 @@ paths: operationId: repos/create-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-an-organization-repository parameters: - *89 requestBody: @@ -57951,7 +58133,7 @@ paths: license_template: type: string description: Choose an [open source license template](https://choosealicense.com/) - that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest//articles/licensing-a-repository/#searching-github-by-license-type) + that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". allow_squash_merge: type: boolean @@ -58059,7 +58241,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &485 title: Full Repository description: Full Repository type: object @@ -58347,8 +58529,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *435 - required: *436 + properties: *437 + required: *438 nullable: true temp_clone_token: type: string @@ -58435,8 +58617,8 @@ paths: title: License Simple description: License Simple type: object - properties: *230 - required: *231 + properties: *232 + required: *233 nullable: true organization: title: Simple User @@ -58463,7 +58645,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &604 + properties: &606 url: type: string format: uri @@ -58479,12 +58661,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &605 + required: &607 - url - key - name - html_url - security_and_analysis: *437 + security_and_analysis: *439 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -58568,7 +58750,7 @@ paths: - network_count - subscribers_count examples: - default: &485 + default: &487 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -59074,7 +59256,7 @@ paths: get: summary: List repository fine-grained permissions for an organization description: |- - Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. @@ -59084,7 +59266,7 @@ paths: operationId: orgs/list-repo-fine-grained-permissions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - *89 responses: @@ -59094,9 +59276,9 @@ paths: application/json: schema: type: array - items: *438 + items: *440 examples: - default: *439 + default: *441 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -59111,7 +59293,7 @@ paths: operationId: repos/get-org-rulesets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-all-organization-repository-rulesets + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-all-organization-repository-rulesets x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59121,7 +59303,7 @@ paths: - *89 - *17 - *19 - - &743 + - &745 name: targets description: | A comma-separated list of rule targets to filter by. @@ -59139,7 +59321,7 @@ paths: application/json: schema: type: array - items: *193 + items: *195 examples: default: value: @@ -59179,7 +59361,7 @@ paths: operationId: repos/create-org-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#create-an-organization-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#create-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59207,22 +59389,20 @@ paths: - push - repository default: branch - enforcement: *170 + enforcement: *172 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *171 - conditions: *440 + items: *173 + conditions: *442 rules: type: array description: An array of rules within the ruleset. - items: &442 + items: &444 title: Repository Rule type: object description: A repository rule. oneOf: - - *172 - - *173 - *174 - *175 - *176 @@ -59242,6 +59422,8 @@ paths: - *190 - *191 - *192 + - *193 + - *194 required: - name - enforcement @@ -59279,9 +59461,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *195 examples: - default: &441 + default: &443 value: id: 21 name: super cool ruleset @@ -59328,16 +59510,16 @@ paths: summary: List organization rule suites description: |- Lists suites of rule evaluations at the organization level. - For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-org-rule-suites externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *89 - - &745 + - &747 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -59347,16 +59529,16 @@ paths: schema: type: string x-multi-segment: true - - *314 + - *316 - *107 - - &746 + - &748 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &747 + - &749 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -59376,7 +59558,7 @@ paths: description: Response content: application/json: - schema: &748 + schema: &750 title: Rule Suites description: Response type: array @@ -59431,7 +59613,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &749 + default: &751 value: - id: 21 actor_id: 12 @@ -59466,21 +59648,21 @@ paths: summary: Get an organization rule suite description: |- Gets information about a suite of rule evaluations from within an organization. - For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-org-rule-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *89 - - &750 + - &752 name: rule_suite_id description: |- The unique identifier of the rule suite result. - To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites) - for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites) + To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites) + for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites) for organizations. in: path required: true @@ -59491,7 +59673,7 @@ paths: description: Response content: application/json: - schema: &751 + schema: &753 title: Rule Suite description: Response type: object @@ -59590,7 +59772,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &752 + default: &754 value: id: 21 actor_id: 12 @@ -59644,7 +59826,7 @@ paths: operationId: repos/get-org-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-an-organization-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59663,9 +59845,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *195 examples: - default: *441 + default: *443 '404': *6 '500': *40 put: @@ -59676,7 +59858,7 @@ paths: operationId: repos/update-org-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#update-an-organization-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#update-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59709,16 +59891,16 @@ paths: - tag - push - repository - enforcement: *170 + enforcement: *172 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *171 - conditions: *440 + items: *173 + conditions: *442 rules: description: An array of rules within the ruleset. type: array - items: *442 + items: *444 examples: default: value: @@ -59753,9 +59935,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *195 examples: - default: *441 + default: *443 '404': *6 '422': *15 '500': *40 @@ -59767,7 +59949,7 @@ paths: operationId: repos/delete-org-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#delete-an-organization-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#delete-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59795,7 +59977,7 @@ paths: operationId: orgs/get-org-ruleset-history externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-organization-ruleset-history parameters: - *89 - *17 @@ -59813,9 +59995,9 @@ paths: application/json: schema: type: array - items: *197 + items: *199 examples: - default: *443 + default: *445 '404': *6 '500': *40 x-github: @@ -59832,7 +60014,7 @@ paths: operationId: orgs/get-org-ruleset-version externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-organization-ruleset-version parameters: - *89 - name: ruleset_id @@ -59852,7 +60034,7 @@ paths: description: Response content: application/json: - schema: *444 + schema: *446 examples: default: value: @@ -59912,23 +60094,23 @@ paths: operationId: secret-scanning/list-alerts-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *89 - - *445 - - *446 - *447 - *448 - *449 - *450 - *451 - *452 + - *453 + - *454 - *112 - *19 - *17 - - &754 + - &756 name: before - 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). + 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. @@ -59936,9 +60118,9 @@ paths: required: false schema: type: string - - &755 + - &757 name: after - 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). + 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. @@ -59946,10 +60128,10 @@ paths: required: false schema: type: string - - *453 - - *454 - *455 - *456 + - *457 + - *458 responses: '200': description: Response @@ -59957,13 +60139,13 @@ paths: application/json: schema: type: array - items: *457 + items: *459 examples: - default: *458 + default: *460 headers: Link: *47 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59981,7 +60163,7 @@ paths: operationId: secret-scanning/list-org-pattern-configs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-organization-pattern-configurations x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59994,9 +60176,9 @@ paths: description: Response content: application/json: - schema: *459 + schema: *461 examples: - default: *460 + default: *462 '403': *29 '404': *6 patch: @@ -60010,7 +60192,7 @@ paths: operationId: secret-scanning/update-org-pattern-configs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#update-organization-pattern-configurations x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60025,7 +60207,7 @@ paths: schema: type: object properties: - pattern_config_version: *200 + pattern_config_version: *202 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -60051,7 +60233,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *200 + custom_pattern_version: *202 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -60103,7 +60285,7 @@ paths: operationId: security-advisories/list-org-repository-advisories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - *89 - *112 @@ -60122,7 +60304,7 @@ paths: - *111 - name: per_page description: The number of advisories to return per page. For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -60149,7 +60331,7 @@ paths: application/json: schema: type: array - items: &776 + items: &778 description: A repository security advisory. type: object properties: @@ -60369,7 +60551,7 @@ paths: login: type: string description: The username of the user credited. - type: *461 + type: *463 credits_detailed: type: array nullable: true @@ -60379,7 +60561,7 @@ paths: type: object properties: user: *4 - type: *461 + type: *463 state: type: string description: The state of the user's acceptance of the @@ -60403,7 +60585,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *317 + items: *319 private_fork: readOnly: true nullable: true @@ -60440,7 +60622,7 @@ paths: - private_fork additionalProperties: false examples: - default: &777 + default: &779 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -60811,13 +60993,13 @@ paths: summary: List security manager teams description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/list-security-manager-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#list-security-manager-teams parameters: - *89 responses: @@ -60827,7 +61009,7 @@ paths: application/json: schema: type: array - items: *462 + items: *464 examples: default: value: @@ -60859,16 +61041,16 @@ paths: summary: Add a security manager team description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/add-security-manager-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#add-a-security-manager-team parameters: - *89 - - *220 + - *222 responses: '204': description: Response @@ -60885,16 +61067,16 @@ paths: summary: Remove a security manager team description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/remove-security-manager-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#remove-a-security-manager-team parameters: - *89 - - *220 + - *222 responses: '204': description: Response @@ -60923,10 +61105,10 @@ paths: operationId: billing/get-github-advanced-security-billing-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *89 - - *463 + - *465 - *17 - *19 responses: @@ -60934,9 +61116,9 @@ paths: description: Success content: application/json: - schema: *464 + schema: *466 examples: - default: *465 + default: *467 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -60954,7 +61136,7 @@ paths: operationId: orgs/get-immutable-releases-settings externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - *89 responses: @@ -61003,7 +61185,7 @@ paths: operationId: orgs/set-immutable-releases-settings externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - *89 responses: @@ -61031,9 +61213,9 @@ paths: enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable - a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an - organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. items: type: integer @@ -61060,7 +61242,7 @@ paths: operationId: orgs/get-immutable-releases-settings-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - *89 - *19 @@ -61080,9 +61262,9 @@ paths: type: integer repositories: type: array - items: *288 + items: *290 examples: - default: *302 + default: *304 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61099,7 +61281,7 @@ paths: operationId: orgs/set-immutable-releases-settings-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - *89 requestBody: @@ -61115,9 +61297,9 @@ paths: enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable - a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an - organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. items: type: integer @@ -61148,10 +61330,10 @@ paths: - orgs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *89 - - *282 + - *284 responses: '204': description: Response @@ -61171,10 +61353,10 @@ paths: - orgs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *89 - - *282 + - *284 responses: '204': description: Response @@ -61195,7 +61377,7 @@ paths: operationId: hosted-compute/list-network-configurations-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - *89 - *17 @@ -61215,9 +61397,9 @@ paths: type: integer network_configurations: type: array - items: *151 + items: *153 examples: - default: *466 + default: *468 headers: Link: *47 x-github: @@ -61236,7 +61418,7 @@ paths: operationId: hosted-compute/create-network-configuration-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - *89 requestBody: @@ -61294,9 +61476,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *153 examples: - default: *152 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61314,18 +61496,18 @@ paths: operationId: hosted-compute/get-network-configuration-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *89 - - *153 + - *155 responses: '200': description: Response content: application/json: - schema: *151 + schema: *153 examples: - default: *152 + default: *154 headers: Link: *47 x-github: @@ -61344,10 +61526,10 @@ paths: operationId: hosted-compute/update-network-configuration-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *89 - - *153 + - *155 requestBody: required: true content: @@ -61400,9 +61582,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *153 examples: - default: *152 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61419,10 +61601,10 @@ paths: operationId: hosted-compute/delete-network-configuration-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *89 - - *153 + - *155 responses: '204': description: Response @@ -61443,18 +61625,18 @@ paths: operationId: hosted-compute/get-network-settings-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *89 - - *467 + - *469 responses: '200': description: Response content: application/json: - schema: *468 + schema: *470 examples: - default: *469 + default: *471 headers: Link: *47 x-github: @@ -61471,7 +61653,7 @@ paths: operationId: teams/list-idp-groups-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - *89 - *17 @@ -61492,7 +61674,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &482 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -61538,7 +61720,7 @@ paths: type: string nullable: true examples: - default: &481 + default: &483 value: groups: - group_id: '123' @@ -61581,10 +61763,10 @@ paths: operationId: copilot/copilot-metrics-for-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - *89 - - *220 + - *222 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -61604,7 +61786,7 @@ paths: - *19 - name: per_page description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -61616,13 +61798,13 @@ paths: application/json: schema: type: array - items: *211 + items: *213 examples: - default: *212 + default: *214 '500': *40 '403': *29 '404': *6 - '422': *213 + '422': *215 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61638,14 +61820,14 @@ paths: operationId: teams/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-teams parameters: - *89 - *17 - *19 - name: team_type description: Filter team results by their type. For more information, see - "[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)" + "[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)" in: query required: false schema: @@ -61662,9 +61844,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - default: *403 + default: *405 headers: Link: *47 '403': *29 @@ -61676,15 +61858,15 @@ paths: post: summary: Create a team description: |- - To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest//articles/setting-team-creation-permissions-in-your-organization)." + To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest/articles/setting-team-creation-permissions-in-your-organization)." - When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/about-teams)". + When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/about-teams)". tags: - teams operationId: teams/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team parameters: - *89 requestBody: @@ -61758,7 +61940,7 @@ paths: description: Response content: application/json: - schema: &470 + schema: &472 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -61821,8 +62003,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *401 - required: *402 + properties: *403 + required: *404 nullable: true members_count: type: integer @@ -62085,7 +62267,7 @@ paths: - repos_count - organization examples: - default: &471 + default: &473 value: id: 1 node_id: MDQ6VGVhbTE= @@ -62153,18 +62335,18 @@ paths: operationId: teams/get-by-name externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-by-name parameters: - *89 - - *220 + - *222 responses: '200': description: Response content: application/json: - schema: *470 + schema: *472 examples: - default: *471 + default: *473 '404': *6 x-github: githubCloudOnly: false @@ -62183,10 +62365,10 @@ paths: operationId: teams/update-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team parameters: - *89 - - *220 + - *222 requestBody: required: false content: @@ -62248,16 +62430,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *470 + schema: *472 examples: - default: *471 + default: *473 '201': description: Response content: application/json: - schema: *470 + schema: *472 examples: - default: *471 + default: *473 '404': *6 '422': *15 '403': *29 @@ -62280,14 +62462,14 @@ paths: operationId: teams/delete-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team parameters: - *89 - - *220 + - *222 responses: '204': description: Response - '422': &474 + '422': &476 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -62301,25 +62483,25 @@ paths: description: |- Lists a connection between a team and an external group. - You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/list-linked-external-idp-groups-to-team-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - *89 - - *220 + - *222 responses: '200': description: Response content: application/json: - schema: *472 + schema: *474 examples: - default: *473 - '422': *474 + default: *475 + '422': *476 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -62330,16 +62512,16 @@ paths: description: |- Creates a connection between a team and an external group. Only one external group can be linked to a team. - You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/link-external-idp-group-to-team-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - *89 - - *220 + - *222 requestBody: required: true content: @@ -62362,10 +62544,10 @@ paths: description: Response content: application/json: - schema: *475 + schema: *477 examples: - default: *476 - '422': *474 + default: *478 + '422': *476 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -62376,20 +62558,20 @@ paths: description: |- Deletes a connection between a team and an external group. - You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - teams operationId: teams/unlink-external-idp-group-from-team-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - *89 - - *220 + - *222 responses: '204': description: Response - '422': *474 + '422': *476 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -62408,10 +62590,10 @@ paths: operationId: teams/list-pending-invitations-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations parameters: - *89 - - *220 + - *222 - *17 - *19 responses: @@ -62421,12 +62603,12 @@ paths: application/json: schema: type: array - items: *382 + items: *384 examples: - default: *383 + default: *385 headers: Link: *47 - '422': *474 + '422': *476 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62444,10 +62626,10 @@ paths: operationId: teams/list-members-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members parameters: - *89 - - *220 + - *222 - name: role description: Filters members returned by their role in the team. in: query @@ -62470,7 +62652,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 x-github: @@ -62492,23 +62674,23 @@ paths: > [!NOTE] > The response contains the `state` of the membership and the member's `role`. - The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). + The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team). tags: - teams operationId: teams/get-membership-for-user-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user parameters: - *89 - - *220 - - *146 + - *222 + - *148 responses: '200': description: Response content: application/json: - schema: &477 + schema: &479 title: Team Membership description: Team Membership type: object @@ -62535,7 +62717,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &818 + response-if-user-is-a-team-maintainer: &820 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -62553,10 +62735,10 @@ paths: description: |- Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. @@ -62569,11 +62751,11 @@ paths: operationId: teams/add-or-update-membership-for-user-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - *89 - - *220 - - *146 + - *222 + - *148 requestBody: required: false content: @@ -62598,9 +62780,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *479 examples: - response-if-users-membership-with-team-is-now-pending: &819 + response-if-users-membership-with-team-is-now-pending: &821 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -62621,10 +62803,10 @@ paths: description: |- To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. @@ -62633,11 +62815,11 @@ paths: operationId: teams/remove-membership-for-user-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user parameters: - *89 - - *220 - - *146 + - *222 + - *148 responses: '204': description: Response @@ -62661,10 +62843,10 @@ paths: operationId: teams/list-repos-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories parameters: - *89 - - *220 + - *222 - *17 - *19 responses: @@ -62674,9 +62856,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 x-github: @@ -62690,7 +62872,7 @@ paths: description: |- Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. + You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. @@ -62703,18 +62885,18 @@ paths: operationId: teams/check-permissions-for-repo-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository parameters: - *89 - - *220 - - *478 - - *479 + - *222 + - *480 + - *481 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &820 + schema: &822 title: Team Repository description: A team's access to a repository. type: object @@ -62737,8 +62919,8 @@ paths: title: License Simple description: License Simple type: object - properties: *230 - required: *231 + properties: *232 + required: *233 nullable: true forks: type: integer @@ -63270,23 +63452,23 @@ paths: put: summary: Add or update team repository permissions description: |- - To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note 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 method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". tags: - teams operationId: teams/add-or-update-repo-permissions-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions parameters: - *89 - - *220 - - *478 - - *479 + - *222 + - *480 + - *481 requestBody: required: false content: @@ -63329,12 +63511,12 @@ paths: operationId: teams/remove-repo-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team parameters: - *89 - - *220 - - *478 - - *479 + - *222 + - *480 + - *481 responses: '204': description: Response @@ -63349,7 +63531,7 @@ paths: description: |- List IdP groups connected to a team on GitHub Enterprise Cloud. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. @@ -63358,19 +63540,19 @@ paths: operationId: teams/list-idp-groups-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team parameters: - *89 - - *220 + - *222 responses: '200': description: Response content: application/json: - schema: *480 + schema: *482 examples: - default: *481 - '422': *474 + default: *483 + '422': *476 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -63381,7 +63563,7 @@ paths: description: |- Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. @@ -63390,10 +63572,10 @@ paths: operationId: teams/create-or-update-idp-group-connections-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections parameters: - *89 - - *220 + - *222 requestBody: required: true content: @@ -63436,7 +63618,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *482 examples: default: value: @@ -63448,7 +63630,7 @@ paths: group_name: Octocat docs members group_description: The people who make your octoworld come to life. - '422': *474 + '422': *476 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -63467,10 +63649,10 @@ paths: operationId: teams/list-child-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams parameters: - *89 - - *220 + - *222 - *17 - *19 responses: @@ -63480,9 +63662,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - response-if-child-teams-exist: &821 + response-if-child-teams-exist: &823 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -63521,9 +63703,9 @@ paths: summary: Enable or disable a security feature for an organization description: |- > [!WARNING] - > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). - Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. @@ -63533,7 +63715,7 @@ paths: operationId: orgs/enable-or-disable-security-product-on-all-org-repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - *89 - name: security_product @@ -63604,15 +63786,15 @@ paths: Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search)." - * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code)." - * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." - * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." - * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." - * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." - * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-cloud@latest/rest/search/search)." + * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-code)." + * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest/graphql/overview/resource-limitations#rate-limit)." + * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph)." + * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners)." + * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest/rest/about-the-rest-api/api-versions)." > [!NOTE] > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. @@ -63621,7 +63803,7 @@ paths: operationId: rate-limit/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user parameters: [] responses: '200': @@ -63636,7 +63818,7 @@ paths: resources: type: object properties: - core: &482 + core: &484 title: Rate Limit type: object properties: @@ -63653,21 +63835,21 @@ paths: - remaining - reset - used - graphql: *482 - search: *482 - code_search: *482 - source_import: *482 - integration_manifest: *482 - code_scanning_upload: *482 - actions_runner_registration: *482 - scim: *482 - dependency_snapshots: *482 - dependency_sbom: *482 - code_scanning_autofix: *482 + graphql: *484 + search: *484 + code_search: *484 + source_import: *484 + integration_manifest: *484 + code_scanning_upload: *484 + actions_runner_registration: *484 + scim: *484 + dependency_snapshots: *484 + dependency_sbom: *484 + code_scanning_autofix: *484 required: - core - search - rate: *482 + rate: *484 required: - rate - resources @@ -63763,23 +63945,23 @@ paths: The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. > [!NOTE] - > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. tags: - repos operationId: repos/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *483 + schema: *485 examples: default-response: summary: Default response @@ -64288,7 +64470,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *484 + '301': *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64297,17 +64479,17 @@ paths: patch: summary: Update a repository description: "**Note**: To edit a repository's topics, use the [Replace all - repository topics](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics) + repository topics](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics) endpoint." tags: - repos operationId: repos/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: false content: @@ -64329,7 +64511,7 @@ paths: description: "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository - visibility](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) + visibility](https://docs.github.com/enterprise-cloud@latest/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private." default: false @@ -64345,7 +64527,7 @@ paths: description: |- Specify which security and analysis features to enable or disable for the repository. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. @@ -64396,7 +64578,7 @@ paths: description: Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets - with AI](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." + with AI](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." properties: status: type: string @@ -64615,10 +64797,10 @@ paths: description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: *485 - '307': &486 + default: *487 + '307': &488 description: Temporary Redirect content: application/json: @@ -64645,10 +64827,10 @@ paths: operationId: repos/delete externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -64669,8 +64851,8 @@ paths: default: value: message: Organization members cannot delete repositories. - documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *486 + documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository + '307': *488 '404': *6 '409': *121 x-github: @@ -64692,13 +64874,13 @@ paths: operationId: actions/list-artifacts-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 - - &503 + - &505 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -64721,7 +64903,7 @@ paths: type: integer artifacts: type: array - items: &487 + items: &489 title: Artifact description: An artifact type: object @@ -64799,7 +64981,7 @@ paths: - expires_at - updated_at examples: - default: &504 + default: &506 value: total_count: 2 artifacts: @@ -64858,11 +65040,11 @@ paths: operationId: actions/get-artifact externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact parameters: - - *478 - - *479 - - &488 + - *480 + - *481 + - &490 name: artifact_id description: The unique identifier of the artifact. in: path @@ -64874,7 +65056,7 @@ paths: description: Response content: application/json: - schema: *487 + schema: *489 examples: default: value: @@ -64910,11 +65092,11 @@ paths: operationId: actions/delete-artifact externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact parameters: - - *478 - - *479 - - *488 + - *480 + - *481 + - *490 responses: '204': description: Response @@ -64936,11 +65118,11 @@ paths: operationId: actions/download-artifact externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact parameters: - - *478 - - *479 - - *488 + - *480 + - *481 + - *490 - name: archive_format in: path required: true @@ -64950,11 +65132,11 @@ paths: '302': description: Response headers: - Location: &623 + Location: &625 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &671 + '410': &673 description: Gone content: application/json: @@ -64977,16 +65159,16 @@ paths: operationId: actions/get-actions-cache-retention-limit-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: &489 + schema: &491 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -65017,15 +65199,15 @@ paths: operationId: actions/set-actions-cache-retention-limit-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: application/json: - schema: *489 + schema: *491 examples: selected_actions: *44 responses: @@ -65052,16 +65234,16 @@ paths: operationId: actions/get-actions-cache-storage-limit-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: &490 + schema: &492 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -65092,15 +65274,15 @@ paths: operationId: actions/set-actions-cache-storage-limit-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: application/json: - schema: *490 + schema: *492 examples: selected_actions: *46 responses: @@ -65129,16 +65311,16 @@ paths: operationId: actions/get-actions-cache-usage externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *491 + schema: *493 examples: default: value: @@ -65162,13 +65344,13 @@ paths: operationId: actions/get-actions-cache-list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 - - &492 + - &494 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -65202,7 +65384,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &495 title: Repository actions caches description: Repository actions caches type: object @@ -65244,7 +65426,7 @@ paths: - total_count - actions_caches examples: - default: &494 + default: &496 value: total_count: 1 actions_caches: @@ -65274,25 +65456,25 @@ paths: operationId: actions/delete-actions-cache-by-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *478 - - *479 + - *480 + - *481 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *492 + - *494 responses: '200': description: Response content: application/json: - schema: *493 + schema: *495 examples: - default: *494 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65310,10 +65492,10 @@ paths: operationId: actions/delete-actions-cache-by-id externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *478 - - *479 + - *480 + - *481 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -65342,11 +65524,11 @@ paths: operationId: actions/get-job-for-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *478 - - *479 - - &495 + - *480 + - *481 + - &497 name: job_id description: The unique identifier of the job. in: path @@ -65358,7 +65540,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &509 title: Job description: Information of a job execution in a workflow run type: object @@ -65663,11 +65845,11 @@ paths: operationId: actions/download-job-logs-for-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *478 - - *479 - - *495 + - *480 + - *481 + - *497 responses: '302': description: Response @@ -65693,11 +65875,11 @@ paths: operationId: actions/re-run-job-for-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *478 - - *479 - - *495 + - *480 + - *481 + - *497 requestBody: required: false content: @@ -65718,7 +65900,7 @@ paths: description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -65740,10 +65922,10 @@ paths: operationId: actions/get-custom-oidc-sub-claim-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Status response @@ -65764,6 +65946,15 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable + OIDC subject claim format. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. If not set at the + repository level, falls back to the organization-level setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default examples: @@ -65791,10 +65982,10 @@ paths: operationId: actions/set-custom-oidc-sub-claim-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -65816,6 +66007,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -65828,7 +66024,7 @@ paths: description: Empty response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -65855,10 +66051,10 @@ paths: operationId: actions/list-repo-organization-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -65876,7 +66072,7 @@ paths: type: integer secrets: type: array - items: &509 + items: &511 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -65896,7 +66092,7 @@ paths: - created_at - updated_at examples: - default: &510 + default: &512 value: total_count: 2 secrets: @@ -65927,11 +66123,11 @@ paths: operationId: actions/list-repo-organization-variables externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables parameters: - - *478 - - *479 - - *496 + - *480 + - *481 + - *498 - *19 responses: '200': @@ -65948,7 +66144,7 @@ paths: type: integer variables: type: array - items: &513 + items: &515 title: Actions Variable type: object properties: @@ -65978,7 +66174,7 @@ paths: - created_at - updated_at examples: - default: &514 + default: &516 value: total_count: 2 variables: @@ -66009,10 +66205,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -66021,11 +66217,11 @@ paths: schema: type: object properties: - enabled: &497 + enabled: &499 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *62 - selected_actions_url: *275 + selected_actions_url: *277 sha_pinning_required: *63 required: - enabled @@ -66054,10 +66250,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -66068,7 +66264,7 @@ paths: schema: type: object properties: - enabled: *497 + enabled: *499 allowed_actions: *62 sha_pinning_required: *63 required: @@ -66090,8 +66286,8 @@ paths: description: |- Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. - For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -66099,16 +66295,16 @@ paths: operationId: actions/get-workflow-access-to-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: &498 + schema: &500 type: object properties: access_level: @@ -66126,7 +66322,7 @@ paths: required: - access_level examples: - default: &499 + default: &501 value: access_level: organization x-github: @@ -66140,8 +66336,8 @@ paths: description: |- Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. - For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -66149,17 +66345,17 @@ paths: operationId: actions/set-workflow-access-to-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: application/json: - schema: *498 + schema: *500 examples: - default: *499 + default: *501 responses: '204': description: Response @@ -66181,16 +66377,16 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *277 + schema: *279 examples: default: value: @@ -66212,10 +66408,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Empty response for successful settings update @@ -66225,7 +66421,7 @@ paths: required: true content: application/json: - schema: *278 + schema: *280 examples: default: summary: Set retention days @@ -66247,10 +66443,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -66258,7 +66454,7 @@ paths: application/json: schema: *64 examples: - default: *279 + default: *281 '404': *6 x-github: enabledForGitHubApps: true @@ -66275,10 +66471,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -66310,16 +66506,16 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *280 + schema: *282 examples: default: *65 '403': *29 @@ -66339,15 +66535,15 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: application/json: - schema: *281 + schema: *283 examples: default: *65 responses: @@ -66371,10 +66567,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -66403,10 +66599,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -66428,7 +66624,7 @@ paths: description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, as well as if GitHub Actions can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -66436,16 +66632,16 @@ paths: operationId: actions/get-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *284 + schema: *286 examples: default: *71 x-github: @@ -66458,7 +66654,7 @@ paths: description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -66466,10 +66662,10 @@ paths: operationId: actions/set-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Success response @@ -66480,7 +66676,7 @@ paths: required: true content: application/json: - schema: *285 + schema: *287 examples: default: *71 x-github: @@ -66502,15 +66698,15 @@ paths: operationId: actions/list-self-hosted-runners-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository parameters: - name: name description: The name of a self-hosted runner. in: query schema: type: string - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -66552,10 +66748,10 @@ paths: operationId: actions/list-runner-applications-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -66563,9 +66759,9 @@ paths: application/json: schema: type: array - items: *289 + items: *291 examples: - default: *290 + default: *292 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66585,10 +66781,10 @@ paths: operationId: actions/generate-runner-jitconfig-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -66631,7 +66827,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *291 + '201': *293 '404': *6 '422': *7 '409': *121 @@ -66660,10 +66856,10 @@ paths: operationId: actions/create-registration-token-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '201': description: Response @@ -66671,7 +66867,7 @@ paths: application/json: schema: *81 examples: - default: *292 + default: *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66697,10 +66893,10 @@ paths: operationId: actions/create-remove-token-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '201': description: Response @@ -66708,7 +66904,7 @@ paths: application/json: schema: *81 examples: - default: *293 + default: *295 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66728,10 +66924,10 @@ paths: operationId: actions/get-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *77 responses: '200': @@ -66740,7 +66936,7 @@ paths: application/json: schema: *78 examples: - default: *294 + default: *296 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66759,10 +66955,10 @@ paths: operationId: actions/delete-self-hosted-runner-from-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *77 responses: '204': @@ -66787,10 +66983,10 @@ paths: operationId: actions/list-labels-for-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *77 responses: '200': *83 @@ -66813,10 +67009,10 @@ paths: operationId: actions/add-custom-labels-to-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *77 requestBody: required: true @@ -66863,10 +67059,10 @@ paths: operationId: actions/set-custom-labels-for-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *77 requestBody: required: true @@ -66914,13 +67110,13 @@ paths: operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *77 responses: - '200': *295 + '200': *297 '404': *6 x-github: githubCloudOnly: false @@ -66945,12 +67141,12 @@ paths: operationId: actions/remove-custom-label-from-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *77 - - *296 + - *298 responses: '200': *83 '404': *6 @@ -66964,7 +67160,7 @@ paths: get: summary: List workflow runs for a repository description: |- - Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. @@ -66976,11 +67172,11 @@ paths: operationId: actions/list-workflow-runs-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *478 - - *479 - - &517 + - *480 + - *481 + - &519 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -66988,7 +67184,7 @@ paths: required: false schema: type: string - - &518 + - &520 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -66996,16 +67192,16 @@ paths: required: false schema: type: string - - &519 + - &521 name: event 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)." + that trigger workflows](https://docs.github.com/enterprise-cloud@latest/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." in: query required: false schema: type: string - - &520 + - &522 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -67032,16 +67228,16 @@ paths: - pending - *17 - *19 - - &521 + - &523 name: created 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)." + 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)." in: query required: false schema: type: string format: date-time - - &500 + - &502 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -67050,13 +67246,13 @@ paths: schema: type: boolean default: false - - &522 + - &524 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &523 + - &525 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -67079,7 +67275,7 @@ paths: type: integer workflow_runs: type: array - items: &501 + items: &503 title: Workflow Run description: An invocation of a workflow type: object @@ -67174,7 +67370,7 @@ paths: that triggered the run. type: array nullable: true - items: *232 + items: *234 created_at: type: string format: date-time @@ -67227,7 +67423,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &545 + properties: &547 id: type: string description: SHA for the commit @@ -67278,7 +67474,7 @@ paths: - name - email nullable: true - required: &546 + required: &548 - id - tree_id - message @@ -67286,8 +67482,8 @@ paths: - author - committer nullable: true - repository: *288 - head_repository: *288 + repository: *290 + head_repository: *290 head_repository_id: type: integer example: 5 @@ -67325,7 +67521,7 @@ paths: - workflow_url - pull_requests examples: - default: &524 + default: &526 value: total_count: 1 workflow_runs: @@ -67559,26 +67755,26 @@ paths: operationId: actions/get-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *478 - - *479 - - &502 + - *480 + - *481 + - &504 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *500 + - *502 responses: '200': description: Response content: application/json: - schema: *501 + schema: *503 examples: - default: &505 + default: &507 value: id: 30433642 name: Build @@ -67817,11 +68013,11 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '204': description: Response @@ -67842,11 +68038,11 @@ paths: operationId: actions/get-reviews-for-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '200': description: Response @@ -67955,7 +68151,7 @@ paths: post: summary: Approve a workflow run for a fork pull request description: |- - Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." + Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -67963,17 +68159,17 @@ paths: operationId: actions/approve-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '201': description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -67998,14 +68194,14 @@ paths: operationId: actions/list-workflow-run-artifacts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 - *17 - *19 - - *503 + - *505 - *112 responses: '200': @@ -68022,9 +68218,9 @@ paths: type: integer artifacts: type: array - items: *487 + items: *489 examples: - default: *504 + default: *506 headers: Link: *47 x-github: @@ -68046,27 +68242,27 @@ paths: operationId: actions/get-workflow-run-attempt externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *478 - - *479 - - *502 - - &506 + - *480 + - *481 + - *504 + - &508 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *500 + - *502 responses: '200': description: Response content: application/json: - schema: *501 + schema: *503 examples: - default: *505 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68077,7 +68273,7 @@ paths: summary: List jobs for a workflow run attempt description: |- Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. @@ -68087,12 +68283,12 @@ paths: operationId: actions/list-jobs-for-workflow-run-attempt externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *478 - - *479 - - *502 - - *506 + - *480 + - *481 + - *504 + - *508 - *17 - *19 responses: @@ -68110,9 +68306,9 @@ paths: type: integer jobs: type: array - items: *507 + items: *509 examples: - default: &508 + default: &510 value: total_count: 1 jobs: @@ -68223,12 +68419,12 @@ paths: operationId: actions/download-workflow-run-attempt-logs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *478 - - *479 - - *502 - - *506 + - *480 + - *481 + - *504 + - *508 responses: '302': description: Response @@ -68254,17 +68450,17 @@ paths: operationId: actions/cancel-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '202': description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -68278,7 +68474,7 @@ paths: post: summary: Review custom deployment protection rules for a workflow run description: |- - Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment)." > [!NOTE] > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). @@ -68289,11 +68485,11 @@ paths: operationId: actions/review-custom-gates-for-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 requestBody: required: true content: @@ -68358,17 +68554,17 @@ paths: operationId: actions/force-cancel-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '202': description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -68383,7 +68579,7 @@ paths: summary: List jobs for a workflow run description: |- Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. @@ -68393,11 +68589,11 @@ paths: operationId: actions/list-jobs-for-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -68427,9 +68623,9 @@ paths: type: integer jobs: type: array - items: *507 + items: *509 examples: - default: *508 + default: *510 headers: Link: *47 x-github: @@ -68452,11 +68648,11 @@ paths: operationId: actions/download-workflow-run-logs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '302': description: Response @@ -68481,11 +68677,11 @@ paths: operationId: actions/delete-workflow-run-logs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '204': description: Response @@ -68510,11 +68706,11 @@ paths: operationId: actions/get-pending-deployments-for-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '200': description: Response @@ -68574,7 +68770,7 @@ paths: items: type: object properties: - type: &638 + type: &640 type: string description: The type of reviewer. enum: @@ -68584,7 +68780,7 @@ paths: reviewer: anyOf: - *4 - - *317 + - *319 required: - environment - wait_timer @@ -68657,11 +68853,11 @@ paths: operationId: actions/review-pending-deployments-for-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 requestBody: required: true content: @@ -68708,12 +68904,12 @@ paths: application/json: schema: type: array - items: &625 + items: &627 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &889 + properties: &891 url: type: string format: uri @@ -68796,9 +68992,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 - required: &890 + properties: *224 + required: *225 + required: &892 - id - node_id - sha @@ -68814,7 +69010,7 @@ paths: - created_at - updated_at examples: - default: &626 + default: &628 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -68868,11 +69064,11 @@ paths: operationId: actions/re-run-workflow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 requestBody: required: false content: @@ -68893,7 +69089,7 @@ paths: description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -68914,11 +69110,11 @@ paths: operationId: actions/re-run-workflow-failed-jobs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 requestBody: required: false content: @@ -68939,7 +69135,7 @@ paths: description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -68961,7 +69157,7 @@ paths: in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing - for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone + for GitHub Actions](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." @@ -68970,11 +69166,11 @@ paths: operationId: actions/get-workflow-run-usage externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *478 - - *479 - - *502 + - *480 + - *481 + - *504 responses: '200': description: Response @@ -69109,10 +69305,10 @@ paths: operationId: actions/list-repo-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -69130,9 +69326,9 @@ paths: type: integer secrets: type: array - items: *509 + items: *511 examples: - default: *510 + default: *512 headers: Link: *47 x-github: @@ -69155,18 +69351,18 @@ paths: operationId: actions/get-repo-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *511 + schema: *513 examples: - default: *512 + default: *514 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69186,19 +69382,19 @@ paths: operationId: actions/get-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 responses: '200': description: Response content: application/json: - schema: *509 + schema: *511 examples: - default: &651 + default: &653 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -69212,7 +69408,7 @@ paths: summary: Create or update a repository secret description: |- Creates or updates a repository secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -69222,11 +69418,11 @@ paths: operationId: actions/create-or-update-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 requestBody: required: true content: @@ -69238,7 +69434,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public - key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -69257,7 +69453,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -69281,11 +69477,11 @@ paths: operationId: actions/delete-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 responses: '204': description: Response @@ -69308,11 +69504,11 @@ paths: operationId: actions/list-repo-variables externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables parameters: - - *478 - - *479 - - *496 + - *480 + - *481 + - *498 - *19 responses: '200': @@ -69329,9 +69525,9 @@ paths: type: integer variables: type: array - items: *513 + items: *515 examples: - default: *514 + default: *516 headers: Link: *47 x-github: @@ -69352,10 +69548,10 @@ paths: operationId: actions/create-repo-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -69382,7 +69578,7 @@ paths: description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -69405,19 +69601,19 @@ paths: operationId: actions/get-repo-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable parameters: - - *478 - - *479 - - *301 + - *480 + - *481 + - *303 responses: '200': description: Response content: application/json: - schema: *513 + schema: *515 examples: - default: &652 + default: &654 value: name: USERNAME value: octocat @@ -69441,11 +69637,11 @@ paths: operationId: actions/update-repo-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable parameters: - - *478 - - *479 - - *301 + - *480 + - *481 + - *303 requestBody: required: true content: @@ -69485,11 +69681,11 @@ paths: operationId: actions/delete-repo-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable parameters: - - *478 - - *479 - - *301 + - *480 + - *481 + - *303 responses: '204': description: Response @@ -69512,10 +69708,10 @@ paths: operationId: actions/list-repo-workflows externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -69533,7 +69729,7 @@ paths: type: integer workflows: type: array - items: &515 + items: &517 title: Workflow description: A GitHub Actions workflow type: object @@ -69638,11 +69834,11 @@ paths: operationId: actions/get-workflow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow parameters: - - *478 - - *479 - - &516 + - *480 + - *481 + - &518 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -69657,7 +69853,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *517 examples: default: value: @@ -69688,11 +69884,11 @@ paths: operationId: actions/disable-workflow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow parameters: - - *478 - - *479 - - *516 + - *480 + - *481 + - *518 responses: '204': description: Response @@ -69715,11 +69911,11 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *478 - - *479 - - *516 + - *480 + - *481 + - *518 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -69804,11 +70000,11 @@ paths: operationId: actions/enable-workflow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow parameters: - - *478 - - *479 - - *516 + - *480 + - *481 + - *518 responses: '204': description: Response @@ -69821,7 +70017,7 @@ paths: get: summary: List workflow runs for a workflow description: |- - List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint @@ -69833,21 +70029,21 @@ paths: operationId: actions/list-workflow-runs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *478 - - *479 - - *516 - - *517 + - *480 + - *481 - *518 - *519 - *520 - - *17 - - *19 - *521 - - *500 - *522 + - *17 + - *19 - *523 + - *502 + - *524 + - *525 responses: '200': description: Response @@ -69863,9 +70059,9 @@ paths: type: integer workflow_runs: type: array - items: *501 + items: *503 examples: - default: *524 + default: *526 headers: Link: *47 x-github: @@ -69886,7 +70082,7 @@ paths: system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing - billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou + billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the @@ -69896,11 +70092,11 @@ paths: operationId: actions/get-workflow-usage externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage parameters: - - *478 - - *479 - - *516 + - *480 + - *481 + - *518 responses: '200': description: Response @@ -69953,16 +70149,16 @@ paths: Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. For more information about viewing repository activity, - see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository)." + see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/viewing-activity-and-data-for-your-repository)." tags: - repos operationId: repos/list-activities externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities parameters: - - *478 - - *479 + - *480 + - *481 - *112 - *17 - *110 @@ -70117,17 +70313,17 @@ paths: "/repos/{owner}/{repo}/assignees": get: summary: List assignees - description: Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest//articles/assigning-issues-and-pull-requests-to-other-github-users/) + description: Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. tags: - issues operationId: issues/list-assignees externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -70139,7 +70335,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 '404': *6 @@ -70162,10 +70358,10 @@ paths: operationId: issues/check-user-can-be-assigned externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *478 - - *479 + - *480 + - *481 - name: assignee in: path required: true @@ -70193,16 +70389,16 @@ paths: The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. - Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - repos operationId: repos/create-attestation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -70304,16 +70500,16 @@ paths: The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - repos operationId: repos/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *110 - *111 @@ -70370,7 +70566,7 @@ paths: initiator: type: string examples: - default: *525 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70388,10 +70584,10 @@ paths: operationId: repos/list-autolinks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -70399,7 +70595,7 @@ paths: application/json: schema: type: array - items: &526 + items: &528 title: Autolink reference description: An autolink reference. type: object @@ -70451,10 +70647,10 @@ paths: operationId: repos/create-autolink externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -70493,9 +70689,9 @@ paths: description: response content: application/json: - schema: *526 + schema: *528 examples: - default: &527 + default: &529 value: id: 1 key_prefix: TICKET- @@ -70524,11 +70720,11 @@ paths: operationId: repos/get-autolink externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *478 - - *479 - - &528 + - *480 + - *481 + - &530 name: autolink_id description: The unique identifier of the autolink. in: path @@ -70540,9 +70736,9 @@ paths: description: Response content: application/json: - schema: *526 + schema: *528 examples: - default: *527 + default: *529 '404': *6 x-github: githubCloudOnly: false @@ -70560,11 +70756,11 @@ paths: operationId: repos/delete-autolink externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *478 - - *479 - - *528 + - *480 + - *481 + - *530 responses: '204': description: Response @@ -70580,16 +70776,16 @@ paths: description: Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security - updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". + updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/check-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response if Dependabot is enabled @@ -70629,16 +70825,16 @@ paths: summary: Enable Dependabot security updates description: Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring - Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". + Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/enable-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -70651,16 +70847,16 @@ paths: summary: Disable Dependabot security updates description: Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring - Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". + Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/disable-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -70678,10 +70874,10 @@ paths: operationId: repos/list-branches externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches parameters: - - *478 - - *479 + - *480 + - *481 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -70719,7 +70915,7 @@ paths: - url protected: type: boolean - protection: &530 + protection: &532 title: Branch Protection description: Branch Protection type: object @@ -70761,7 +70957,7 @@ paths: required: - contexts - checks - enforce_admins: &533 + enforce_admins: &535 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -70776,7 +70972,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &535 + required_pull_request_reviews: &537 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -70797,7 +70993,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *317 + items: *319 apps: description: The list of apps with review dismissal access. @@ -70826,7 +71022,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *317 + items: *319 apps: description: The list of apps allowed to bypass pull request requirements. @@ -70852,7 +71048,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &532 + restrictions: &534 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -70915,7 +71111,7 @@ paths: type: string teams: type: array - items: *317 + items: *319 apps: type: array items: @@ -71127,14 +71323,14 @@ paths: operationId: repos/get-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch parameters: - - *478 - - *479 - - &531 + - *480 + - *481 + - &533 name: branch description: The name of the branch. Cannot contain wildcard characters. To - use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). + use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql). in: path required: true schema: @@ -71145,14 +71341,14 @@ paths: description: Response content: application/json: - schema: &541 + schema: &543 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &595 + commit: &597 title: Commit description: Commit type: object @@ -71186,7 +71382,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &529 + properties: &531 name: type: string example: '"Chris Wanstrath"' @@ -71202,7 +71398,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *529 + properties: *531 nullable: true message: type: string @@ -71223,7 +71419,7 @@ paths: required: - sha - url - verification: &658 + verification: &660 title: Verification type: object properties: @@ -71257,12 +71453,12 @@ paths: nullable: true oneOf: - *4 - - *299 + - *301 committer: nullable: true oneOf: - *4 - - *299 + - *301 parents: type: array items: @@ -71293,7 +71489,7 @@ paths: type: integer files: type: array - items: &608 + items: &610 title: Diff Entry description: Diff Entry type: object @@ -71377,7 +71573,7 @@ paths: - self protected: type: boolean - protection: *530 + protection: *532 protection_url: type: string format: uri @@ -71484,7 +71680,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *484 + '301': *486 '404': *6 x-github: githubCloudOnly: false @@ -71497,24 +71693,24 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response content: application/json: - schema: *530 + schema: *532 examples: default: value: @@ -71692,7 +71888,7 @@ paths: put: summary: Update branch protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Protecting a branch requires admin or owner permissions to the repository. @@ -71706,11 +71902,11 @@ paths: operationId: repos/update-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: true content: @@ -71801,7 +71997,7 @@ paths: approving reviews when someone pushes a new commit. require_code_owner_reviews: type: boolean - description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) + description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest/articles/about-code-owners/) review them. required_approving_review_count: type: integer @@ -71869,7 +72065,7 @@ paths: commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear - commit history](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/requiring-a-linear-commit-history)" + commit history](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation.' allow_force_pushes: type: boolean @@ -71877,7 +72073,7 @@ paths: with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to - a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + a protected branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation."' nullable: true allow_deletions: @@ -71885,7 +72081,7 @@ paths: description: 'Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, - see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation.' block_creations: type: boolean @@ -71965,7 +72161,7 @@ paths: url: type: string format: uri - required_status_checks: &538 + required_status_checks: &540 title: Status Check Policy description: Status Check Policy type: object @@ -72041,7 +72237,7 @@ paths: items: *4 teams: type: array - items: *317 + items: *319 apps: type: array items: *5 @@ -72059,7 +72255,7 @@ paths: items: *4 teams: type: array - items: *317 + items: *319 apps: type: array items: *5 @@ -72117,7 +72313,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *532 + restrictions: *534 required_conversation_resolution: type: object properties: @@ -72220,18 +72416,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/delete-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '204': description: Response @@ -72247,26 +72443,26 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-admin-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response content: application/json: - schema: *533 + schema: *535 examples: - default: &534 + default: &536 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -72278,7 +72474,7 @@ paths: post: summary: Set admin branch protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. tags: @@ -72286,19 +72482,19 @@ paths: operationId: repos/set-admin-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response content: application/json: - schema: *533 + schema: *535 examples: - default: *534 + default: *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72307,7 +72503,7 @@ paths: delete: summary: Delete admin branch protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. tags: @@ -72315,11 +72511,11 @@ paths: operationId: repos/delete-admin-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '204': description: Response @@ -72335,26 +72531,26 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-pull-request-review-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: &536 + default: &538 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -72437,7 +72633,7 @@ paths: patch: summary: Update pull request review protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. @@ -72448,11 +72644,11 @@ paths: operationId: repos/update-pull-request-review-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: false content: @@ -72489,7 +72685,7 @@ paths: approving reviews when someone pushes a new commit. require_code_owner_reviews: type: boolean - description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) + description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest/articles/about-code-owners/) have reviewed. required_approving_review_count: type: integer @@ -72550,9 +72746,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: *536 + default: *538 '422': *15 x-github: githubCloudOnly: false @@ -72564,18 +72760,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/delete-pull-request-review-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '204': description: Response @@ -72589,9 +72785,9 @@ paths: get: summary: Get commit signature protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help. + When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest/articles/signing-commits-with-gpg) in GitHub Help. > [!NOTE] > You must enable branch protection to require signed commits. @@ -72600,19 +72796,19 @@ paths: operationId: repos/get-commit-signature-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response content: application/json: - schema: *533 + schema: *535 examples: - default: &537 + default: &539 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -72625,7 +72821,7 @@ paths: post: summary: Create commit signature protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. tags: @@ -72633,19 +72829,19 @@ paths: operationId: repos/create-commit-signature-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response content: application/json: - schema: *533 + schema: *535 examples: - default: *537 + default: *539 '404': *6 x-github: githubCloudOnly: false @@ -72655,7 +72851,7 @@ paths: delete: summary: Delete commit signature protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. tags: @@ -72663,11 +72859,11 @@ paths: operationId: repos/delete-commit-signature-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '204': description: Response @@ -72683,26 +72879,26 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-status-checks-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response content: application/json: - schema: *538 + schema: *540 examples: - default: &539 + default: &541 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -72718,7 +72914,7 @@ paths: patch: summary: Update status check protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. tags: @@ -72726,11 +72922,11 @@ paths: operationId: repos/update-status-check-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: false content: @@ -72782,9 +72978,9 @@ paths: description: Response content: application/json: - schema: *538 + schema: *540 examples: - default: *539 + default: *541 '404': *6 '422': *15 x-github: @@ -72797,18 +72993,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/remove-status-check-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '204': description: Response @@ -72823,18 +73019,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-all-status-check-contexts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response @@ -72859,18 +73055,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/add-status-check-contexts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: false content: @@ -72928,18 +73124,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/set-status-check-contexts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: false content: @@ -72994,18 +73190,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/remove-status-check-contexts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: content: application/json: @@ -73058,7 +73254,7 @@ paths: get: summary: Get access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists who has access to this protected branch. @@ -73069,17 +73265,17 @@ paths: operationId: repos/get-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response content: application/json: - schema: *532 + schema: *534 examples: default: value: @@ -73160,7 +73356,7 @@ paths: delete: summary: Delete access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Disables the ability to restrict who can push to this branch. tags: @@ -73168,11 +73364,11 @@ paths: operationId: repos/delete-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '204': description: Response @@ -73185,7 +73381,7 @@ paths: get: summary: Get apps with access to the protected branch description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: @@ -73193,11 +73389,11 @@ paths: operationId: repos/get-apps-with-access-to-protected-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response @@ -73207,7 +73403,7 @@ paths: type: array items: *5 examples: - default: &540 + default: &542 value: - id: 1 slug: octoapp @@ -73254,7 +73450,7 @@ paths: post: summary: Add app access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: @@ -73262,11 +73458,11 @@ paths: operationId: repos/add-app-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: true content: @@ -73300,7 +73496,7 @@ paths: type: array items: *5 examples: - default: *540 + default: *542 '422': *15 x-github: githubCloudOnly: false @@ -73311,7 +73507,7 @@ paths: put: summary: Set app access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: @@ -73319,11 +73515,11 @@ paths: operationId: repos/set-app-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: true content: @@ -73357,7 +73553,7 @@ paths: type: array items: *5 examples: - default: *540 + default: *542 '422': *15 x-github: githubCloudOnly: false @@ -73368,7 +73564,7 @@ paths: delete: summary: Remove app access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: @@ -73376,11 +73572,11 @@ paths: operationId: repos/remove-app-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: true content: @@ -73414,7 +73610,7 @@ paths: type: array items: *5 examples: - default: *540 + default: *542 '422': *15 x-github: githubCloudOnly: false @@ -73426,7 +73622,7 @@ paths: get: summary: Get teams with access to the protected branch description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the teams who have push access to this branch. The list includes child teams. tags: @@ -73434,11 +73630,11 @@ paths: operationId: repos/get-teams-with-access-to-protected-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response @@ -73446,9 +73642,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - default: *403 + default: *405 '404': *6 x-github: githubCloudOnly: false @@ -73458,7 +73654,7 @@ paths: post: summary: Add team access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified teams push access for this branch. You can also give push access to child teams. tags: @@ -73466,11 +73662,11 @@ paths: operationId: repos/add-team-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: false content: @@ -73506,9 +73702,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - default: *403 + default: *405 '422': *15 x-github: githubCloudOnly: false @@ -73519,7 +73715,7 @@ paths: put: summary: Set team access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. tags: @@ -73527,11 +73723,11 @@ paths: operationId: repos/set-team-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: false content: @@ -73567,9 +73763,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - default: *403 + default: *405 '422': *15 x-github: githubCloudOnly: false @@ -73580,7 +73776,7 @@ paths: delete: summary: Remove team access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a team to push to this branch. You can also remove push access for child teams. tags: @@ -73588,11 +73784,11 @@ paths: operationId: repos/remove-team-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: content: application/json: @@ -73627,9 +73823,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - default: *403 + default: *405 '422': *15 x-github: githubCloudOnly: false @@ -73641,7 +73837,7 @@ paths: get: summary: Get users with access to the protected branch description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the people who have push access to this branch. tags: @@ -73649,11 +73845,11 @@ paths: operationId: repos/get-users-with-access-to-protected-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 responses: '200': description: Response @@ -73663,7 +73859,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 '404': *6 x-github: githubCloudOnly: false @@ -73673,7 +73869,7 @@ paths: post: summary: Add user access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified people push access for this branch. @@ -73685,11 +73881,11 @@ paths: operationId: repos/add-user-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: true content: @@ -73722,7 +73918,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 '422': *15 x-github: githubCloudOnly: false @@ -73733,7 +73929,7 @@ paths: put: summary: Set user access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. @@ -73745,11 +73941,11 @@ paths: operationId: repos/set-user-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: true content: @@ -73782,7 +73978,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 '422': *15 x-github: githubCloudOnly: false @@ -73793,7 +73989,7 @@ paths: delete: summary: Remove user access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a user to push to this branch. @@ -73805,11 +74001,11 @@ paths: operationId: repos/remove-user-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: true content: @@ -73842,7 +74038,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 '422': *15 x-github: githubCloudOnly: false @@ -73857,7 +74053,7 @@ paths: Renames a branch in a repository. > [!NOTE] - > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". + > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/renaming-a-branch)". The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. @@ -73867,11 +74063,11 @@ paths: operationId: repos/rename-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 requestBody: required: true content: @@ -73893,7 +74089,7 @@ paths: description: Response content: application/json: - schema: *541 + schema: *543 examples: default: value: @@ -74000,15 +74196,15 @@ paths: operationId: repos/list-repo-push-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#list-repository-push-rule-bypass-requests + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/bypass-requests#list-repository-push-rule-bypass-requests x-github: githubCloudOnly: true enabledForGitHubApps: true category: repos subcategory: bypass-requests parameters: - - *478 - - *479 + - *480 + - *481 - *105 - *106 - *107 @@ -74022,9 +74218,9 @@ paths: application/json: schema: type: array - items: *312 + items: *314 examples: - default: *313 + default: *315 '404': *6 '500': *40 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -74037,15 +74233,15 @@ paths: operationId: repos/get-repo-push-bypass-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#get-a-repository-push-bypass-request + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/bypass-requests#get-a-repository-push-bypass-request x-github: githubCloudOnly: true enabledForGitHubApps: true category: repos subcategory: bypass-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: bypass_request_number in: path required: true @@ -74059,7 +74255,7 @@ paths: description: Response content: application/json: - schema: *312 + schema: *314 examples: default: value: @@ -74111,15 +74307,15 @@ paths: operationId: secret-scanning/list-repo-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - - *478 - - *479 + - *480 + - *481 - *105 - *106 - *107 @@ -74133,9 +74329,9 @@ paths: application/json: schema: type: array - items: *315 + items: *317 examples: - default: *316 + default: *318 '404': *6 '403': *29 '500': *40 @@ -74152,15 +74348,15 @@ paths: operationId: secret-scanning/get-bypass-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - - *478 - - *479 + - *480 + - *481 - name: bypass_request_number in: path required: true @@ -74172,7 +74368,7 @@ paths: description: A single bypass request. content: application/json: - schema: *315 + schema: *317 examples: default: value: @@ -74223,15 +74419,15 @@ paths: operationId: secret-scanning/review-bypass-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - - *478 - - *479 + - *480 + - *481 - name: bypass_request_number in: path required: true @@ -74295,15 +74491,15 @@ paths: operationId: secret-scanning/dismiss-bypass-response externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - - *478 - - *479 + - *480 + - *481 - name: bypass_response_id in: path required: true @@ -74334,10 +74530,10 @@ paths: operationId: checks/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -74425,13 +74621,13 @@ paths: and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have - to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) + to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About - status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)". + status checks](https://docs.github.com/enterprise-cloud@latest/articles/about-status-checks#checks)". maxItems: 50 items: type: object @@ -74513,11 +74709,11 @@ paths: app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the - [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) + [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs - and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + and requested actions](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -74616,7 +74812,7 @@ paths: description: Response content: application/json: - schema: &542 + schema: &544 title: CheckRun description: A check performed on the code of a given code change type: object @@ -74727,16 +74923,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *232 - deployment: &882 + items: *234 + deployment: &884 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -74803,8 +74999,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 required: - id - node_id @@ -75014,11 +75210,11 @@ paths: operationId: checks/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run parameters: - - *478 - - *479 - - &543 + - *480 + - *481 + - &545 name: check_run_id description: The unique identifier of the check run. in: path @@ -75030,9 +75226,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *544 examples: - default: &544 + default: &546 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -75130,11 +75326,11 @@ paths: operationId: checks/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run parameters: - - *478 - - *479 - - *543 + - *480 + - *481 + - *545 requestBody: required: true content: @@ -75214,12 +75410,12 @@ paths: UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you - have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) + have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details - about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)". + about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-cloud@latest/articles/about-status-checks#checks)". maxItems: 50 items: type: object @@ -75299,7 +75495,7 @@ paths: which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check - runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + runs and requested actions](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -75374,9 +75570,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *544 examples: - default: *544 + default: *546 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75394,11 +75590,11 @@ paths: operationId: checks/list-annotations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations parameters: - - *478 - - *479 - - *543 + - *480 + - *481 + - *545 - *17 - *19 responses: @@ -75483,25 +75679,25 @@ paths: post: summary: Rerequest a check run description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) to update the check_run if desired. + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) to update the check_run if desired. - For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". tags: - checks operationId: checks/rerequest-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run parameters: - - *478 - - *479 - - *543 + - *480 + - *481 + - *545 responses: '201': description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -75526,7 +75722,7 @@ paths: post: summary: Create a check suite description: |- - Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)". + Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites)". > [!NOTE] > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. @@ -75537,10 +75733,10 @@ paths: operationId: checks/create-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -75562,7 +75758,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &547 + schema: &549 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -75626,7 +75822,7 @@ paths: nullable: true pull_requests: type: array - items: *232 + items: *234 nullable: true app: title: GitHub app @@ -75637,9 +75833,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 - repository: *288 + properties: *224 + required: *225 + repository: *290 created_at: type: string format: date-time @@ -75648,12 +75844,12 @@ paths: type: string format: date-time nullable: true - head_commit: &915 + head_commit: &917 title: Simple Commit description: A commit. type: object - properties: *545 - required: *546 + properties: *547 + required: *548 latest_check_runs_count: type: integer check_runs_url: @@ -75681,7 +75877,7 @@ paths: - check_runs_url - pull_requests examples: - default: &548 + default: &550 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -75972,9 +76168,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *547 + schema: *549 examples: - default: *548 + default: *550 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75984,17 +76180,17 @@ paths: patch: summary: Update repository preferences for check suites description: |- - Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite). + Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. tags: - checks operationId: checks/set-suites-preferences externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -76055,7 +76251,7 @@ paths: required: - app_id - setting - repository: *288 + repository: *290 examples: default: value: @@ -76301,11 +76497,11 @@ paths: operationId: checks/get-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite parameters: - - *478 - - *479 - - &549 + - *480 + - *481 + - &551 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -76317,9 +76513,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *549 examples: - default: *548 + default: *550 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76340,19 +76536,19 @@ paths: operationId: checks/list-for-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *478 - - *479 - - *549 - - &601 + - *480 + - *481 + - *551 + - &603 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &602 + - &604 name: status description: Returns check runs with the specified `status`. in: query @@ -76391,9 +76587,9 @@ paths: type: integer check_runs: type: array - items: *542 + items: *544 examples: - default: &603 + default: &605 value: total_count: 1 check_runs: @@ -76485,7 +76681,7 @@ paths: post: summary: Rerequest a check suite description: Triggers GitHub to rerequest an existing check suite, without pushing - new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) + new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. tags: @@ -76493,17 +76689,17 @@ paths: operationId: checks/rerequest-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite parameters: - - *478 - - *479 - - *549 + - *480 + - *481 + - *551 responses: '201': description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -76528,23 +76724,23 @@ paths: operationId: code-scanning/list-alerts-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *478 - - *479 - - *321 - - *322 + - *480 + - *481 + - *323 + - *324 - *19 - *17 - - &565 + - &567 name: ref 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`. in: query required: false - schema: *550 - - &566 + schema: *552 + - &568 name: pr description: The number of the pull request for the results you want to list. in: query @@ -76569,13 +76765,13 @@ paths: be returned. in: query required: false - schema: *323 + schema: *325 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *551 + schema: *553 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -76599,7 +76795,7 @@ paths: updated_at: *139 url: *136 html_url: *137 - instances_url: *552 + instances_url: *554 state: *115 fixed_at: *141 dismissed_by: @@ -76610,11 +76806,11 @@ paths: required: *21 nullable: true dismissed_at: *140 - dismissed_reason: *553 - dismissed_comment: *554 - rule: *555 - tool: *556 - most_recent_instance: *557 + dismissed_reason: *555 + dismissed_comment: *556 + rule: *557 + tool: *558 + most_recent_instance: *559 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -76740,14 +76936,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &558 + '403': &560 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76765,11 +76961,11 @@ paths: operationId: code-scanning/get-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *478 - - *479 - - &559 + - *480 + - *481 + - &561 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -76783,7 +76979,7 @@ paths: description: Response content: application/json: - schema: &560 + schema: &562 type: object properties: number: *131 @@ -76791,7 +76987,7 @@ paths: updated_at: *139 url: *136 html_url: *137 - instances_url: *552 + instances_url: *554 state: *115 fixed_at: *141 dismissed_by: @@ -76802,8 +76998,8 @@ paths: required: *21 nullable: true dismissed_at: *140 - dismissed_reason: *553 - dismissed_comment: *554 + dismissed_reason: *555 + dismissed_comment: *556 rule: type: object properties: @@ -76857,8 +77053,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *556 - most_recent_instance: *557 + tool: *558 + most_recent_instance: *559 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -76957,9 +77153,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *558 + '403': *560 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76975,11 +77171,11 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *478 - - *479 - - *559 + - *480 + - *481 + - *561 requestBody: required: true content: @@ -76994,8 +77190,8 @@ paths: enum: - open - dismissed - dismissed_reason: *553 - dismissed_comment: *554 + dismissed_reason: *555 + dismissed_comment: *556 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -77023,7 +77219,7 @@ paths: description: Response content: application/json: - schema: *560 + schema: *562 examples: default: value: @@ -77099,14 +77295,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &564 + '403': &566 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *198 + '503': *200 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -77124,17 +77320,17 @@ paths: operationId: code-scanning/get-autofix externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *478 - - *479 - - *559 + - *480 + - *481 + - *561 responses: '200': description: Response content: application/json: - schema: &561 + schema: &563 type: object properties: status: @@ -77160,13 +77356,13 @@ paths: - description - started_at examples: - default: &562 + default: &564 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &563 + '400': &565 description: Bad Request content: application/json: @@ -77177,9 +77373,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *558 + '403': *560 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77200,31 +77396,31 @@ paths: operationId: code-scanning/create-autofix externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *478 - - *479 - - *559 + - *480 + - *481 + - *561 responses: '200': description: OK content: application/json: - schema: *561 + schema: *563 examples: - default: *562 + default: *564 '202': description: Accepted content: application/json: - schema: *561 + schema: *563 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *563 + '400': *565 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -77234,7 +77430,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77254,11 +77450,11 @@ paths: operationId: code-scanning/commit-autofix externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *478 - - *479 - - *559 + - *480 + - *481 + - *561 requestBody: required: false content: @@ -77303,12 +77499,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *563 - '403': *564 + '400': *565 + '403': *566 '404': *6 '422': description: Unprocessable Entity - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77326,15 +77522,15 @@ paths: operationId: code-scanning/list-alert-instances externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *478 - - *479 - - *559 + - *480 + - *481 + - *561 - *19 - *17 - - *565 - - *566 + - *567 + - *568 responses: '200': description: Response @@ -77345,10 +77541,10 @@ paths: items: type: object properties: - ref: *550 - analysis_key: *567 - environment: *568 - category: *569 + ref: *552 + analysis_key: *569 + environment: *570 + category: *571 state: type: string description: State of a code scanning alert instance. @@ -77363,7 +77559,7 @@ paths: properties: text: type: string - location: *570 + location: *572 html_url: type: string classifications: @@ -77371,7 +77567,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *571 + items: *573 examples: default: value: @@ -77408,9 +77604,9 @@ paths: end_column: 50 classifications: - source - '403': *558 + '403': *560 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77440,27 +77636,27 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *478 - - *479 - - *321 - - *322 + - *480 + - *481 + - *323 + - *324 - *19 - *17 - - *566 + - *568 - name: ref in: query description: The Git reference for the analyses 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`. required: false - schema: *550 + schema: *552 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &572 + schema: &574 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -77481,23 +77677,23 @@ paths: application/json: schema: type: array - items: &573 + items: &575 type: object properties: - ref: *550 - commit_sha: &581 + ref: *552 + commit_sha: &583 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *567 + analysis_key: *569 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *569 + category: *571 error: type: string example: error reading field xyz @@ -77521,8 +77717,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *572 - tool: *556 + sarif_id: *574 + tool: *558 deletable: type: boolean warning: @@ -77583,9 +77779,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *558 + '403': *560 '404': *6 - '503': *198 + '503': *200 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -77607,7 +77803,7 @@ paths: For very old analyses this data is not available, and `0` is returned in this field. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. @@ -77617,10 +77813,10 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -77633,7 +77829,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *575 examples: response: summary: application/json response @@ -77687,14 +77883,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *558 + '403': *560 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *198 + '503': *200 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -77772,10 +77968,10 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -77828,9 +78024,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *564 + '403': *566 '404': *6 - '503': *198 + '503': *200 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -77848,10 +78044,10 @@ paths: operationId: code-scanning/list-codeql-databases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -77859,7 +78055,7 @@ paths: application/json: schema: type: array - items: &574 + items: &576 title: CodeQL Database description: A CodeQL database. type: object @@ -77970,9 +78166,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *558 + '403': *560 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77987,7 +78183,7 @@ paths: By default this endpoint returns JSON metadata about the CodeQL database. To download the CodeQL database binary content, set the `Accept` header of the request - to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure + to [`application/zip`](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure your HTTP client is configured to follow redirects or use the `Location` header to make a second request to get the redirect URL. @@ -77997,10 +78193,10 @@ paths: operationId: code-scanning/get-codeql-database externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - name: language in: path description: The language of the CodeQL database. @@ -78012,7 +78208,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *576 examples: default: value: @@ -78044,11 +78240,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &612 + '302': &614 description: Found - '403': *558 + '403': *560 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78066,10 +78262,10 @@ paths: operationId: code-scanning/delete-codeql-database externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *478 - - *479 + - *480 + - *481 - name: language in: path description: The language of the CodeQL database. @@ -78079,9 +78275,9 @@ paths: responses: '204': description: Response - '403': *564 + '403': *566 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78094,7 +78290,7 @@ paths: description: |- Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. - Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest//code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). Use the `owner` and `repo` parameters in the URL to specify the controller repository that will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. @@ -78105,10 +78301,10 @@ paths: operationId: code-scanning/create-variant-analysis externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -78117,7 +78313,7 @@ paths: type: object additionalProperties: false properties: - language: &575 + language: &577 type: string description: The language targeted by the CodeQL query enum: @@ -78197,7 +78393,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &579 + schema: &581 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -78207,7 +78403,7 @@ paths: description: The ID of the variant analysis. controller_repo: *122 actor: *4 - query_language: *575 + query_language: *577 query_pack_url: type: string description: The download url for the query pack. @@ -78254,7 +78450,7 @@ paths: items: type: object properties: - repository: &576 + repository: &578 title: Repository Identifier description: Repository Identifier type: object @@ -78290,7 +78486,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &580 + analysis_status: &582 type: string description: The new status of the CodeQL variant analysis repository task. @@ -78322,7 +78518,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &577 + access_mismatch_repos: &579 type: object properties: repository_count: @@ -78336,7 +78532,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *576 + items: *578 required: - repository_count - repositories @@ -78358,8 +78554,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *577 - over_limit_repos: *577 + no_codeql_db_repos: *579 + over_limit_repos: *579 required: - access_mismatch_repos - not_found_repos @@ -78375,7 +78571,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &578 + value: &580 summary: Default response value: id: 1 @@ -78521,17 +78717,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *578 + value: *580 repository_lists: summary: Response for a successful variant analysis submission - value: *578 + value: *580 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78550,10 +78746,10 @@ paths: operationId: code-scanning/get-variant-analysis externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *478 - - *479 + - *480 + - *481 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -78565,11 +78761,11 @@ paths: description: Response content: application/json: - schema: *579 + schema: *581 examples: - default: *578 + default: *580 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78588,9 +78784,9 @@ paths: operationId: code-scanning/get-variant-analysis-repo-task externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *478 + - *480 - name: repo in: path description: The name of the controller repository. @@ -78625,7 +78821,7 @@ paths: type: object properties: repository: *122 - analysis_status: *580 + analysis_status: *582 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -78729,7 +78925,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78748,10 +78944,10 @@ paths: operationId: code-scanning/get-default-setup externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -78836,9 +79032,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *558 + '403': *560 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78855,10 +79051,10 @@ paths: operationId: code-scanning/update-default-setup externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -78925,7 +79121,7 @@ paths: description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -78950,7 +79146,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *564 + '403': *566 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -78964,7 +79160,7 @@ paths: content: application/json: schema: *3 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78975,7 +79171,7 @@ paths: summary: Upload an analysis as SARIF data description: "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, - see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif).\"\n\nThere + see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, @@ -78993,7 +79189,7 @@ paths: analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results - exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| + exceed one or more limits](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** \ |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| @@ -79019,10 +79215,10 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -79030,7 +79226,7 @@ paths: schema: type: object properties: - commit_sha: *581 + commit_sha: *583 ref: type: string description: |- @@ -79042,7 +79238,7 @@ paths: description: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding - string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secure-coding/sarif-support-for-code-scanning)." + string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secure-coding/sarif-support-for-code-scanning)." type: string checkout_uri: description: |- @@ -79088,7 +79284,7 @@ paths: schema: type: object properties: - id: *572 + id: *574 url: type: string description: The REST API URL for checking the status of the upload. @@ -79102,11 +79298,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *564 + '403': *566 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *198 + '503': *200 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -79123,10 +79319,10 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *478 - - *479 + - *480 + - *481 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -79172,10 +79368,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *558 + '403': *560 '404': description: Not Found if the sarif id does not match any upload - '503': *198 + '503': *200 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -79195,10 +79391,10 @@ paths: operationId: code-security/get-configuration-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -79271,16 +79467,16 @@ paths: file. For more information about the correct CODEOWNERS syntax, - see "[About code owners](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + see "[About code owners](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." tags: - repos operationId: repos/codeowners-errors externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors parameters: - - *478 - - *479 + - *480 + - *481 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -79396,12 +79592,12 @@ paths: operationId: codespaces/list-in-repository-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user parameters: - *17 - *19 - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -79417,7 +79613,7 @@ paths: type: integer codespaces: type: array - items: *393 + items: *395 examples: default: value: @@ -79713,10 +79909,10 @@ paths: operationId: codespaces/create-with-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -79779,22 +79975,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -79814,12 +80010,12 @@ paths: operationId: codespaces/list-devcontainers-in-repository-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user parameters: - *17 - *19 - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -79881,10 +80077,10 @@ paths: operationId: codespaces/repo-machines-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -79919,14 +80115,14 @@ paths: type: integer machines: type: array - items: &827 + items: &829 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *583 - required: *584 + properties: *585 + required: *586 examples: - default: &828 + default: &830 value: total_count: 2 machines: @@ -79964,10 +80160,10 @@ paths: operationId: codespaces/pre-flight-with-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *478 - - *479 + - *480 + - *481 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -80049,10 +80245,10 @@ paths: operationId: codespaces/check-permissions-for-devcontainer externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *478 - - *479 + - *480 + - *481 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -80097,7 +80293,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80116,10 +80312,10 @@ paths: operationId: codespaces/list-repo-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -80137,7 +80333,7 @@ paths: type: integer secrets: type: array - items: &588 + items: &590 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -80157,7 +80353,7 @@ paths: - created_at - updated_at examples: - default: *585 + default: *587 headers: Link: *47 x-github: @@ -80178,18 +80374,18 @@ paths: operationId: codespaces/get-repo-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *586 + schema: *588 examples: - default: *587 + default: *589 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -80207,19 +80403,19 @@ paths: operationId: codespaces/get-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 responses: '200': description: Response content: application/json: - schema: *588 + schema: *590 examples: - default: *589 + default: *591 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80229,7 +80425,7 @@ paths: summary: Create or update a repository secret description: |- Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. tags: @@ -80237,11 +80433,11 @@ paths: operationId: codespaces/create-or-update-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 requestBody: required: true content: @@ -80253,7 +80449,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public - key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -80269,7 +80465,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -80291,11 +80487,11 @@ paths: operationId: codespaces/delete-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 responses: '204': description: Response @@ -80321,10 +80517,10 @@ paths: operationId: repos/list-collaborators externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *478 - - *479 + - *480 + - *481 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -80366,7 +80562,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &590 + properties: &592 login: type: string example: octocat @@ -80459,7 +80655,7 @@ paths: user_view_type: type: string example: public - required: &591 + required: &593 - avatar_url - events_url - followers_url @@ -80531,11 +80727,11 @@ paths: operationId: repos/check-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *478 - - *479 - - *146 + - *480 + - *481 + - *148 responses: '204': description: Response if user is a collaborator @@ -80549,21 +80745,21 @@ paths: put: summary: Add a repository collaborator description: |- - Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). - Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. + Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. - For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: ``` Cannot assign {member} permission of {role name} ``` - Note 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note 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 method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - The 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 [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations). + The 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 [API](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations). For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. @@ -80579,11 +80775,11 @@ paths: operationId: repos/add-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *478 - - *479 - - *146 + - *480 + - *481 + - *148 requestBody: required: false content: @@ -80609,7 +80805,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &670 + schema: &672 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -80620,7 +80816,7 @@ paths: example: 42 type: integer format: int64 - repository: *288 + repository: *290 invitee: title: Simple User description: A GitHub user. @@ -80798,7 +80994,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *263 + schema: *265 '403': *29 x-github: triggersNotification: true @@ -80830,17 +81026,17 @@ paths: Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". tags: - repos operationId: repos/remove-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *478 - - *479 - - *146 + - *480 + - *481 + - *148 responses: '204': description: No Content when collaborator was removed from the repository. @@ -80869,11 +81065,11 @@ paths: operationId: repos/get-collaborator-permission-level externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *478 - - *479 - - *146 + - *480 + - *481 + - *148 responses: '200': description: if user has admin permissions @@ -80893,8 +81089,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *590 - required: *591 + properties: *592 + required: *593 nullable: true required: - permission @@ -80936,7 +81132,7 @@ paths: description: |- Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -80947,10 +81143,10 @@ paths: operationId: repos/list-commit-comments-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -80960,7 +81156,7 @@ paths: application/json: schema: type: array - items: &592 + items: &594 title: Commit Comment description: Commit Comment type: object @@ -81001,8 +81197,8 @@ paths: updated_at: type: string format: date-time - author_association: *224 - reactions: *225 + author_association: *226 + reactions: *227 required: - url - html_url @@ -81018,7 +81214,7 @@ paths: - created_at - updated_at examples: - default: &597 + default: &599 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -81064,7 +81260,7 @@ paths: description: |- Gets a specified commit comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -81075,19 +81271,19 @@ paths: operationId: repos/get-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 responses: '200': description: Response content: application/json: - schema: *592 + schema: *594 examples: - default: &598 + default: &600 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -81131,7 +81327,7 @@ paths: description: |- Updates the contents of a specified commit comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -81142,11 +81338,11 @@ paths: operationId: repos/update-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 requestBody: required: true content: @@ -81168,7 +81364,7 @@ paths: description: Response content: application/json: - schema: *592 + schema: *594 examples: default: value: @@ -81217,11 +81413,11 @@ paths: operationId: repos/delete-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 responses: '204': description: Response @@ -81234,19 +81430,19 @@ paths: "/repos/{owner}/{repo}/comments/{comment_id}/reactions": get: summary: List reactions for a commit comment - description: List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). + description: List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/list-for-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. in: query required: false @@ -81270,7 +81466,7 @@ paths: application/json: schema: type: array - items: &593 + items: &595 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -81313,7 +81509,7 @@ paths: - content - created_at examples: - default: &674 + default: &676 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -81348,7 +81544,7 @@ paths: subcategory: reactions post: summary: Create reaction for a commit comment - description: Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). + description: Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. tags: @@ -81356,11 +81552,11 @@ paths: operationId: reactions/create-for-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 requestBody: required: true content: @@ -81370,7 +81566,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the commit comment. enum: - "+1" @@ -81392,9 +81588,9 @@ paths: description: Reaction exists content: application/json: - schema: *593 + schema: *595 examples: - default: &594 + default: &596 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -81423,9 +81619,9 @@ paths: description: Reaction created content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '422': *15 x-github: githubCloudOnly: false @@ -81439,18 +81635,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). + Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/delete-for-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *478 - - *479 - - *243 - - &675 + - *480 + - *481 + - *245 + - &677 name: reaction_id description: The unique identifier of the reaction. in: path @@ -81503,10 +81699,10 @@ paths: operationId: repos/list-commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits parameters: - - *478 - - *479 + - *480 + - *481 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -81562,9 +81758,9 @@ paths: application/json: schema: type: array - items: *595 + items: *597 examples: - default: &728 + default: &730 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -81648,7 +81844,7 @@ paths: get: summary: List branches for HEAD commit description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. tags: @@ -81656,11 +81852,11 @@ paths: operationId: repos/list-branches-for-head-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit parameters: - - *478 - - *479 - - &596 + - *480 + - *481 + - &598 name: commit_sha description: The SHA of the commit. in: path @@ -81719,7 +81915,7 @@ paths: description: |- Lists the comments for a specified commit. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -81730,11 +81926,11 @@ paths: operationId: repos/list-comments-for-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments parameters: - - *478 - - *479 - - *596 + - *480 + - *481 + - *598 - *17 - *19 responses: @@ -81744,9 +81940,9 @@ paths: application/json: schema: type: array - items: *592 + items: *594 examples: - default: *597 + default: *599 headers: Link: *47 x-github: @@ -81759,9 +81955,9 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -81772,11 +81968,11 @@ paths: operationId: repos/create-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment parameters: - - *478 - - *479 - - *596 + - *480 + - *481 + - *598 requestBody: required: true content: @@ -81811,9 +82007,9 @@ paths: description: Response content: application/json: - schema: *592 + schema: *594 examples: - default: *598 + default: *600 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -81839,11 +82035,11 @@ paths: operationId: repos/list-pull-requests-associated-with-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *478 - - *479 - - *596 + - *480 + - *481 + - *598 - *17 - *19 responses: @@ -81853,9 +82049,9 @@ paths: application/json: schema: type: array - items: *599 + items: *601 examples: - default: &720 + default: &722 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -82350,7 +82546,7 @@ paths: > [!NOTE] > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. @@ -82390,13 +82586,13 @@ paths: operationId: repos/get-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit parameters: - - *478 - - *479 + - *480 + - *481 - *19 - *17 - - &600 + - &602 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -82411,9 +82607,9 @@ paths: description: Response content: application/json: - schema: *595 + schema: *597 examples: - default: &705 + default: &707 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -82501,7 +82697,7 @@ paths: schema: type: string examples: - default: &609 + default: &611 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -82514,7 +82710,7 @@ paths: schema: type: string examples: - default: &610 + default: &612 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -82541,7 +82737,7 @@ paths: '422': *15 '404': *6 '500': *40 - '503': *198 + '503': *200 '409': *121 x-github: githubCloudOnly: false @@ -82557,7 +82753,7 @@ paths: > [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -82565,13 +82761,13 @@ paths: operationId: checks/list-for-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *478 - - *479 - - *600 - - *601 + - *480 + - *481 - *602 + - *603 + - *604 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -82605,9 +82801,9 @@ paths: type: integer check_runs: type: array - items: *542 + items: *544 examples: - default: *603 + default: *605 headers: Link: *47 x-github: @@ -82630,11 +82826,11 @@ paths: operationId: checks/list-suites-for-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *478 - - *479 - - *600 + - *480 + - *481 + - *602 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -82642,7 +82838,7 @@ paths: schema: type: integer example: 1 - - *601 + - *603 - *17 - *19 responses: @@ -82660,7 +82856,7 @@ paths: type: integer check_suites: type: array - items: *547 + items: *549 examples: default: value: @@ -82858,11 +83054,11 @@ paths: operationId: repos/get-combined-status-for-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *478 - - *479 - - *600 + - *480 + - *481 + - *602 - *17 - *19 responses: @@ -82929,7 +83125,7 @@ paths: type: string total_count: type: integer - repository: *288 + repository: *290 commit_url: type: string format: uri @@ -83058,11 +83254,11 @@ paths: operationId: repos/list-commit-statuses-for-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *478 - - *479 - - *600 + - *480 + - *481 + - *602 - *17 - *19 responses: @@ -83072,7 +83268,7 @@ paths: application/json: schema: type: array - items: &781 + items: &783 title: Status description: The status of a commit. type: object @@ -83153,7 +83349,7 @@ paths: site_admin: false headers: Link: *47 - '301': *484 + '301': *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83171,7 +83367,7 @@ paths: The `health_percentage` score is defined as a percentage of how many of the recommended community health files are present. For more information, see - "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." + "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." `content_reports_enabled` is only returned for organization-owned repositories. tags: @@ -83179,10 +83375,10 @@ paths: operationId: repos/get-community-profile-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -83211,20 +83407,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *604 - required: *605 + properties: *606 + required: *607 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &606 + properties: &608 url: type: string format: uri html_url: type: string format: uri - required: &607 + required: &609 - url - html_url nullable: true @@ -83232,32 +83428,32 @@ paths: title: License Simple description: License Simple type: object - properties: *230 - required: *231 + properties: *232 + required: *233 nullable: true contributing: title: Community Health File type: object - properties: *606 - required: *607 + properties: *608 + required: *609 nullable: true readme: title: Community Health File type: object - properties: *606 - required: *607 + properties: *608 + required: *609 nullable: true issue_template: title: Community Health File type: object - properties: *606 - required: *607 + properties: *608 + required: *609 nullable: true pull_request_template: title: Community Health File type: object - properties: *606 - required: *607 + properties: *608 + required: *609 nullable: true required: - code_of_conduct @@ -83326,11 +83522,11 @@ paths: get: summary: Compare two commits description: |- - Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.diff`**: Returns the diff of the commit. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. @@ -83346,7 +83542,7 @@ paths: - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. - For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." + For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api)." **Signature verification object** @@ -83382,10 +83578,10 @@ paths: operationId: repos/compare-commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits parameters: - - *478 - - *479 + - *480 + - *481 - *19 - *17 - name: basehead @@ -83428,8 +83624,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *595 - merge_base_commit: *595 + base_commit: *597 + merge_base_commit: *597 status: type: string enum: @@ -83449,10 +83645,10 @@ paths: example: 6 commits: type: array - items: *595 + items: *597 files: type: array - items: *608 + items: *610 required: - url - html_url @@ -83698,15 +83894,15 @@ paths: schema: type: string examples: - default: *609 + default: *611 application/vnd.github.patch: schema: type: string examples: - default: *610 + default: *612 '404': *6 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83718,7 +83914,7 @@ paths: description: |- Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -83732,9 +83928,9 @@ paths: **Notes**: - - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). + - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree). - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - more files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). + more files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree). - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - If the requested file's size is: - 1 MB or smaller: All features of this endpoint are supported. @@ -83746,10 +83942,10 @@ paths: operationId: repos/get-content externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content parameters: - - *478 - - *479 + - *480 + - *481 - name: path description: path parameter in: path @@ -83909,7 +84105,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &611 + response-if-content-is-a-file-github-object: &613 summary: Response if content is a file value: type: file @@ -84041,7 +84237,7 @@ paths: - size - type - url - - &733 + - &735 title: Content File description: Content File type: object @@ -84242,7 +84438,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *611 + response-if-content-is-a-file: *613 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -84311,7 +84507,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *612 + '302': *614 '304': *37 x-github: githubCloudOnly: false @@ -84324,7 +84520,7 @@ paths: Creates a new file or replaces an existing file in a repository. > [!NOTE] - > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. tags: @@ -84332,10 +84528,10 @@ paths: operationId: repos/create-or-update-file-contents externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents parameters: - - *478 - - *479 + - *480 + - *481 - name: path description: path parameter in: path @@ -84428,7 +84624,7 @@ paths: description: Response content: application/json: - schema: &613 + schema: &615 title: File Commit description: File Commit type: object @@ -84580,7 +84776,7 @@ paths: description: Response content: application/json: - schema: *613 + schema: *615 examples: example-for-creating-a-file: value: @@ -84634,7 +84830,7 @@ paths: schema: oneOf: - *3 - - &653 + - &655 description: Repository rule violation was detected type: object properties: @@ -84655,7 +84851,7 @@ paths: items: type: object properties: - placeholder_id: &773 + placeholder_id: &775 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -84679,16 +84875,16 @@ paths: You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. > [!NOTE] - > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/delete-file externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file parameters: - - *478 - - *479 + - *480 + - *481 - name: path description: path parameter in: path @@ -84749,7 +84945,7 @@ paths: description: Response content: application/json: - schema: *613 + schema: *615 examples: default: value: @@ -84784,7 +84980,7 @@ paths: '422': *15 '404': *6 '409': *121 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84802,10 +84998,10 @@ paths: operationId: repos/list-contributors externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors parameters: - - *478 - - *479 + - *480 + - *481 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -84926,26 +85122,26 @@ paths: operationId: dependabot/list-alerts-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *478 - - *479 - - *338 - - *339 + - *480 + - *481 - *340 - *341 - *342 + - *343 + - *344 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *343 - - *614 - - *344 - *345 + - *616 - *346 + - *347 + - *348 - *112 - *110 - *111 @@ -84957,7 +85153,7 @@ paths: application/json: schema: type: array - items: &618 + items: &620 type: object description: A Dependabot alert. properties: @@ -85004,7 +85200,7 @@ paths: - direct - transitive - inconclusive - security_advisory: *615 + security_advisory: *617 security_vulnerability: *135 url: *136 html_url: *137 @@ -85035,8 +85231,8 @@ paths: nullable: true maxLength: 280 fixed_at: *141 - auto_dismissed_at: *616 - dismissal_request: *617 + auto_dismissed_at: *618 + dismissal_request: *619 assignees: type: array description: The users assigned to this alert. @@ -85289,11 +85485,11 @@ paths: operationId: dependabot/get-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *478 - - *479 - - &619 + - *480 + - *481 + - &621 name: alert_number in: path description: |- @@ -85308,7 +85504,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *620 examples: default: value: @@ -85430,7 +85626,7 @@ paths: patch: summary: Update a Dependabot alert description: |- - The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: @@ -85438,11 +85634,11 @@ paths: operationId: dependabot/update-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *478 - - *479 - - *619 + - *480 + - *481 + - *621 requestBody: required: true content: @@ -85498,7 +85694,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *620 examples: default: value: @@ -85626,10 +85822,10 @@ paths: operationId: dependabot/list-repo-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -85647,7 +85843,7 @@ paths: type: integer secrets: type: array - items: &622 + items: &624 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -85698,18 +85894,18 @@ paths: operationId: dependabot/get-repo-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *620 + schema: *622 examples: - default: *621 + default: *623 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85727,17 +85923,17 @@ paths: operationId: dependabot/get-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 responses: '200': description: Response content: application/json: - schema: *622 + schema: *624 examples: default: value: @@ -85753,7 +85949,7 @@ paths: summary: Create or update a repository secret description: |- Creates or updates a repository secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -85761,11 +85957,11 @@ paths: operationId: dependabot/create-or-update-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 requestBody: required: true content: @@ -85777,7 +85973,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public - key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -85793,7 +85989,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -85815,11 +86011,11 @@ paths: operationId: dependabot/delete-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *478 - - *479 - - *298 + - *480 + - *481 + - *300 responses: '204': description: Response @@ -85839,10 +86035,10 @@ paths: operationId: dependency-graph/diff-range externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *478 - - *479 + - *480 + - *481 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -86000,10 +86196,10 @@ paths: operationId: dependency-graph/export-sbom externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -86239,10 +86435,10 @@ paths: operationId: dependency-graph/fetch-sbom-report externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - name: sbom_uuid in: path required: true @@ -86253,7 +86449,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *623 + Location: *625 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -86272,10 +86468,10 @@ paths: operationId: dependency-graph/generate-sbom-report externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '201': description: Response @@ -86311,10 +86507,10 @@ paths: operationId: dependency-graph/create-repository-snapshot externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -86389,7 +86585,7 @@ paths: - version - url additionalProperties: false - metadata: &624 + metadata: &626 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -86422,7 +86618,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *624 + metadata: *626 resolved: type: object description: A collection of resolved package dependencies. @@ -86435,7 +86631,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *624 + metadata: *626 relationship: type: string description: A notation of whether a dependency is requested @@ -86562,10 +86758,10 @@ paths: operationId: repos/list-deployments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments parameters: - - *478 - - *479 + - *480 + - *481 - name: sha description: The SHA recorded at creation time. in: query @@ -86605,9 +86801,9 @@ paths: application/json: schema: type: array - items: *625 + items: *627 examples: - default: *626 + default: *628 headers: Link: *47 x-github: @@ -86632,7 +86828,7 @@ paths: the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. - By default, [commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) for every submitted context must be in a `success` + By default, [commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. @@ -86671,10 +86867,10 @@ paths: operationId: repos/create-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -86696,7 +86892,7 @@ paths: default: true required_contexts: type: array - description: The [status](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) + description: The [status](https://docs.github.com/enterprise-cloud@latest/rest/commits/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. @@ -86755,7 +86951,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *627 examples: simple-example: summary: Simple example @@ -86826,11 +87022,11 @@ paths: operationId: repos/get-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment parameters: - - *478 - - *479 - - &627 + - *480 + - *481 + - &629 name: deployment_id description: deployment_id parameter in: path @@ -86842,7 +87038,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *627 examples: default: value: @@ -86897,7 +87093,7 @@ paths: * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * Mark the active deployment as inactive by adding any non-successful deployment status. - For more information, see "[Create a deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status)." + For more information, see "[Create a deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status)." OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. tags: @@ -86905,11 +87101,11 @@ paths: operationId: repos/delete-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment parameters: - - *478 - - *479 - - *627 + - *480 + - *481 + - *629 responses: '204': description: Response @@ -86929,11 +87125,11 @@ paths: operationId: repos/list-deployment-statuses externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses parameters: - - *478 - - *479 - - *627 + - *480 + - *481 + - *629 - *17 - *19 responses: @@ -86943,7 +87139,7 @@ paths: application/json: schema: type: array - items: &628 + items: &630 title: Deployment Status description: The status of a deployment. type: object @@ -87034,8 +87230,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 required: - id - node_id @@ -87102,11 +87298,11 @@ paths: operationId: repos/create-deployment-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status parameters: - - *478 - - *479 - - *627 + - *480 + - *481 + - *629 requestBody: required: true content: @@ -87181,9 +87377,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *630 examples: - default: &629 + default: &631 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -87237,11 +87433,11 @@ paths: operationId: repos/get-deployment-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status parameters: - - *478 - - *479 - - *627 + - *480 + - *481 + - *629 - name: status_id in: path required: true @@ -87252,9 +87448,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *630 examples: - default: *629 + default: *631 '404': *6 x-github: githubCloudOnly: false @@ -87274,19 +87470,19 @@ paths: operationId: code-scanning/list-dismissal-requests-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - - *478 - - *479 - - *630 - - *631 + - *480 + - *481 - *632 - *633 + - *634 + - *635 - *17 - *19 responses: @@ -87296,9 +87492,9 @@ paths: application/json: schema: type: array - items: *634 + items: *636 examples: - default: *635 + default: *637 '404': *6 '403': *29 '500': *40 @@ -87315,15 +87511,15 @@ paths: operationId: code-scanning/get-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: alert_number in: path required: true @@ -87335,7 +87531,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *634 + schema: *636 examples: default: value: @@ -87384,15 +87580,15 @@ paths: operationId: code-scanning/review-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: alert_number in: path required: true @@ -87444,19 +87640,19 @@ paths: operationId: dependabot/list-dismissal-requests-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *478 - - *479 - - *630 - - *631 + - *480 + - *481 - *632 - *633 + - *634 + - *635 - *17 - *19 responses: @@ -87466,9 +87662,9 @@ paths: application/json: schema: type: array - items: *636 + items: *638 examples: - default: *637 + default: *639 '404': *6 '403': *29 '500': *40 @@ -87485,15 +87681,15 @@ paths: operationId: dependabot/get-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#get-a-dismissal-request-for-a-dependabot-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#get-a-dismissal-request-for-a-dependabot-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: alert_number in: path required: true @@ -87505,7 +87701,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *636 + schema: *638 examples: default: value: @@ -87549,15 +87745,15 @@ paths: operationId: dependabot/create-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#create-a-dismissal-request-for-a-dependabot-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#create-a-dismissal-request-for-a-dependabot-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: alert_number in: path required: true @@ -87595,7 +87791,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *636 + schema: *638 examples: default: value: @@ -87639,15 +87835,15 @@ paths: operationId: dependabot/review-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#review-a-dismissal-request-for-a-dependabot-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#review-a-dismissal-request-for-a-dependabot-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: alert_number in: path required: true @@ -87711,15 +87907,15 @@ paths: operationId: dependabot/cancel-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: alert_number in: path required: true @@ -87745,19 +87941,19 @@ paths: operationId: secret-scanning/list-repo-dismissal-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - *105 - *106 - *107 - - *352 + - *354 - *17 - *19 responses: @@ -87767,9 +87963,9 @@ paths: application/json: schema: type: array - items: *354 + items: *356 examples: - default: *355 + default: *357 '404': *6 '403': *29 '500': *40 @@ -87787,15 +87983,15 @@ paths: operationId: secret-scanning/get-dismissal-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: alert_number in: path required: true @@ -87807,7 +88003,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *354 + schema: *356 examples: default: value: @@ -87858,15 +88054,15 @@ paths: operationId: secret-scanning/review-dismissal-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: alert_number in: path required: true @@ -87921,7 +88117,7 @@ paths: 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 Enterprise Cloud 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/enterprise-cloud@latest//webhooks/event-payloads/#repository_dispatch)." + You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud 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/enterprise-cloud@latest/webhooks/event-payloads/#repository_dispatch)." 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. @@ -87933,10 +88129,10 @@ paths: operationId: repos/create-dispatch-event externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -87991,10 +88187,10 @@ paths: operationId: repos/get-all-environments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -88011,7 +88207,7 @@ paths: type: integer environments: type: array - items: &639 + items: &641 title: Environment description: Details of a deployment environment type: object @@ -88063,7 +88259,7 @@ paths: type: type: string example: wait_timer - wait_timer: &641 + wait_timer: &643 type: integer example: 30 description: The amount of time to delay a job after @@ -88100,11 +88296,11 @@ paths: items: type: object properties: - type: *638 + type: *640 reviewer: anyOf: - *4 - - *317 + - *319 required: - id - node_id @@ -88124,7 +88320,7 @@ paths: - id - node_id - type - deployment_branch_policy: &642 + deployment_branch_policy: &644 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -88238,11 +88434,11 @@ paths: operationId: repos/get-environment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment parameters: - - *478 - - *479 - - &640 + - *480 + - *481 + - &642 name: environment_name in: path required: true @@ -88255,9 +88451,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: - default: &643 + default: &645 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -88339,11 +88535,11 @@ paths: operationId: repos/create-or-update-environment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment parameters: - - *478 - - *479 - - *640 + - *480 + - *481 + - *642 requestBody: required: false content: @@ -88352,7 +88548,7 @@ paths: type: object nullable: true properties: - wait_timer: *641 + wait_timer: *643 prevent_self_review: type: boolean example: false @@ -88369,13 +88565,13 @@ paths: items: type: object properties: - type: *638 + type: *640 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *642 + deployment_branch_policy: *644 additionalProperties: false examples: default: @@ -88395,9 +88591,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: - default: *643 + default: *645 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -88419,11 +88615,11 @@ paths: operationId: repos/delete-an-environment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment parameters: - - *478 - - *479 - - *640 + - *480 + - *481 + - *642 responses: '204': description: Default response @@ -88446,11 +88642,11 @@ paths: operationId: repos/list-deployment-branch-policies externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *478 - - *479 - - *640 + - *480 + - *481 + - *642 - *17 - *19 responses: @@ -88468,7 +88664,7 @@ paths: example: 2 branch_policies: type: array - items: &644 + items: &646 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -88523,11 +88719,11 @@ paths: operationId: repos/create-deployment-branch-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *478 - - *479 - - *640 + - *480 + - *481 + - *642 requestBody: required: true content: @@ -88573,9 +88769,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *646 examples: - example-wildcard: &645 + example-wildcard: &647 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -88615,12 +88811,12 @@ paths: operationId: repos/get-deployment-branch-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *478 - - *479 - - *640 - - &646 + - *480 + - *481 + - *642 + - &648 name: branch_policy_id in: path required: true @@ -88632,9 +88828,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *646 examples: - default: *645 + default: *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88651,12 +88847,12 @@ paths: operationId: repos/update-deployment-branch-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *478 - - *479 - - *640 - - *646 + - *480 + - *481 + - *642 + - *648 requestBody: required: true content: @@ -88684,9 +88880,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *646 examples: - default: *645 + default: *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88703,12 +88899,12 @@ paths: operationId: repos/delete-deployment-branch-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *478 - - *479 - - *640 - - *646 + - *480 + - *481 + - *642 + - *648 responses: '204': description: Response @@ -88721,9 +88917,9 @@ paths: get: summary: Get all deployment protection rules for an environment description: |- - Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). + For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: @@ -88731,11 +88927,11 @@ paths: operationId: repos/get-all-deployment-protection-rules externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *640 - - *479 - - *478 + - *642 + - *481 + - *480 responses: '200': description: List of deployment protection rules @@ -88751,7 +88947,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &647 + items: &649 title: Deployment protection rule description: Deployment protection rule type: object @@ -88770,7 +88966,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &648 + app: &650 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -88859,7 +89055,7 @@ paths: The authenticated user must have admin or owner permissions to the repository to use this endpoint. - For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). + For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -88867,11 +89063,11 @@ paths: operationId: repos/create-deployment-protection-rule externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *640 - - *479 - - *478 + - *642 + - *481 + - *480 requestBody: content: application/json: @@ -88892,9 +89088,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *647 + schema: *649 examples: - default: &649 + default: &651 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -88917,9 +89113,9 @@ paths: The authenticated user must have admin or owner permissions to the repository to use this endpoint. - For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)". + For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app)". OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: @@ -88927,11 +89123,11 @@ paths: operationId: repos/list-custom-deployment-rule-integrations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *640 - - *479 - - *478 + - *642 + - *481 + - *480 - *19 - *17 responses: @@ -88950,7 +89146,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *648 + items: *650 examples: default: value: @@ -88973,9 +89169,9 @@ paths: get: summary: Get a custom deployment protection rule description: |- - Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). + For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: @@ -88983,12 +89179,12 @@ paths: operationId: repos/get-custom-deployment-protection-rule externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *478 - - *479 - - *640 - - &650 + - *480 + - *481 + - *642 + - &652 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -89000,9 +89196,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *649 examples: - default: *649 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89021,12 +89217,12 @@ paths: operationId: repos/disable-deployment-protection-rule externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *640 - - *479 - - *478 - - *650 + - *642 + - *481 + - *480 + - *652 responses: '204': description: Response @@ -89050,11 +89246,11 @@ paths: operationId: actions/list-environment-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets parameters: - - *478 - - *479 - - *640 + - *480 + - *481 + - *642 - *17 - *19 responses: @@ -89072,9 +89268,9 @@ paths: type: integer secrets: type: array - items: *509 + items: *511 examples: - default: *510 + default: *512 headers: Link: *47 x-github: @@ -89097,19 +89293,19 @@ paths: operationId: actions/get-environment-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key parameters: - - *478 - - *479 - - *640 + - *480 + - *481 + - *642 responses: '200': description: Response content: application/json: - schema: *511 + schema: *513 examples: - default: *512 + default: *514 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89129,20 +89325,20 @@ paths: operationId: actions/get-environment-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret parameters: - - *478 - - *479 - - *640 - - *298 + - *480 + - *481 + - *642 + - *300 responses: '200': description: Response content: application/json: - schema: *509 + schema: *511 examples: - default: *651 + default: *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89152,7 +89348,7 @@ paths: summary: Create or update an environment secret description: |- Creates or updates an environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -89162,12 +89358,12 @@ paths: operationId: actions/create-or-update-environment-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *478 - - *479 - - *640 - - *298 + - *480 + - *481 + - *642 + - *300 requestBody: required: true content: @@ -89179,7 +89375,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public - key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -89198,7 +89394,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -89222,12 +89418,12 @@ paths: operationId: actions/delete-environment-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret parameters: - - *478 - - *479 - - *640 - - *298 + - *480 + - *481 + - *642 + - *300 responses: '204': description: Default response @@ -89250,12 +89446,12 @@ paths: operationId: actions/list-environment-variables externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables parameters: - - *478 - - *479 - - *640 - - *496 + - *480 + - *481 + - *642 + - *498 - *19 responses: '200': @@ -89272,9 +89468,9 @@ paths: type: integer variables: type: array - items: *513 + items: *515 examples: - default: *514 + default: *516 headers: Link: *47 x-github: @@ -89295,11 +89491,11 @@ paths: operationId: actions/create-environment-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable parameters: - - *478 - - *479 - - *640 + - *480 + - *481 + - *642 requestBody: required: true content: @@ -89326,7 +89522,7 @@ paths: description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -89349,20 +89545,20 @@ paths: operationId: actions/get-environment-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable parameters: - - *478 - - *479 - - *640 - - *301 + - *480 + - *481 + - *642 + - *303 responses: '200': description: Response content: application/json: - schema: *513 + schema: *515 examples: - default: *652 + default: *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89381,12 +89577,12 @@ paths: operationId: actions/update-environment-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable parameters: - - *478 - - *479 - - *301 - - *640 + - *480 + - *481 + - *303 + - *642 requestBody: required: true content: @@ -89426,12 +89622,12 @@ paths: operationId: actions/delete-environment-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable parameters: - - *478 - - *479 - - *301 - - *640 + - *480 + - *481 + - *303 + - *642 responses: '204': description: Response @@ -89451,10 +89647,10 @@ paths: operationId: activity/list-repo-events externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -89464,7 +89660,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: 200-response: value: @@ -89520,10 +89716,10 @@ paths: operationId: repos/list-forks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks parameters: - - *478 - - *479 + - *480 + - *481 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -89545,7 +89741,7 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: default: value: @@ -89680,10 +89876,10 @@ paths: operationId: repos/create-fork externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: false content: @@ -89715,9 +89911,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: *485 + default: *487 '400': *14 '422': *15 '403': *29 @@ -89736,10 +89932,10 @@ paths: operationId: git/create-blob externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob + url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -89798,8 +89994,8 @@ paths: application/json: schema: oneOf: - - *263 - - *653 + - *265 + - *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89811,7 +90007,7 @@ paths: description: |- The `content` in the response will always be Base64 encoded. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw blob data. - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. @@ -89822,10 +90018,10 @@ paths: operationId: git/get-blob externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob + url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob parameters: - - *478 - - *479 + - *480 + - *481 - name: file_sha in: path required: true @@ -89922,10 +90118,10 @@ paths: operationId: git/create-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit + url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -90034,7 +90230,7 @@ paths: description: Response content: application/json: - schema: &654 + schema: &656 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -90246,17 +90442,17 @@ paths: operationId: git/get-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object + url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object parameters: - - *478 - - *479 - - *596 + - *480 + - *481 + - *598 responses: '200': description: Response content: application/json: - schema: *654 + schema: *656 examples: default: value: @@ -90302,7 +90498,7 @@ paths: When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. > [!NOTE] - > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. tags: @@ -90310,11 +90506,11 @@ paths: operationId: git/list-matching-refs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references parameters: - - *478 - - *479 - - &655 + - *480 + - *481 + - &657 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -90331,7 +90527,7 @@ paths: application/json: schema: type: array - items: &656 + items: &658 title: Git Reference description: Git references within a repository type: object @@ -90398,25 +90594,25 @@ paths: Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. > [!NOTE] - > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". tags: - git operationId: git/get-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference parameters: - - *478 - - *479 - - *655 + - *480 + - *481 + - *657 responses: '200': description: Response content: application/json: - schema: *656 + schema: *658 examples: - default: &657 + default: &659 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -90443,10 +90639,10 @@ paths: operationId: git/create-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -90475,9 +90671,9 @@ paths: description: Response content: application/json: - schema: *656 + schema: *658 examples: - default: *657 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -90501,11 +90697,11 @@ paths: operationId: git/update-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference parameters: - - *478 - - *479 - - *655 + - *480 + - *481 + - *657 requestBody: required: true content: @@ -90534,9 +90730,9 @@ paths: description: Response content: application/json: - schema: *656 + schema: *658 examples: - default: *657 + default: *659 '422': *15 '409': *121 x-github: @@ -90552,11 +90748,11 @@ paths: operationId: git/delete-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference parameters: - - *478 - - *479 - - *655 + - *480 + - *481 + - *657 responses: '204': description: Response @@ -90573,7 +90769,7 @@ paths: post: summary: Create a tag object description: |- - Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. **Signature verification object** @@ -90609,10 +90805,10 @@ paths: operationId: git/create-tag externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object + url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -90679,7 +90875,7 @@ paths: description: Response content: application/json: - schema: &659 + schema: &661 title: Git Tag description: Metadata for a Git tag type: object @@ -90730,7 +90926,7 @@ paths: - sha - type - url - verification: *658 + verification: *660 required: - sha - url @@ -90740,7 +90936,7 @@ paths: - tag - message examples: - default: &660 + default: &662 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -90811,10 +91007,10 @@ paths: operationId: git/get-tag externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag + url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag parameters: - - *478 - - *479 + - *480 + - *481 - name: tag_sha in: path required: true @@ -90825,9 +91021,9 @@ paths: description: Response content: application/json: - schema: *659 + schema: *661 examples: - default: *660 + default: *662 '404': *6 '409': *121 x-github: @@ -90841,7 +91037,7 @@ paths: description: |- The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference)." + If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference)." Returns an error if you try to delete a file that does not exist. tags: @@ -90849,10 +91045,10 @@ paths: operationId: git/create-tree externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree + url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -90925,7 +91121,7 @@ paths: description: Response content: application/json: - schema: &661 + schema: &663 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -91019,10 +91215,10 @@ paths: operationId: git/get-tree externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree + url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree parameters: - - *478 - - *479 + - *480 + - *481 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -91045,7 +91241,7 @@ paths: description: Response content: application/json: - schema: *661 + schema: *663 examples: default-response: summary: Default response @@ -91102,10 +91298,10 @@ paths: operationId: repos/list-webhooks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -91115,7 +91311,7 @@ paths: application/json: schema: type: array - items: &662 + items: &664 title: Webhook description: Webhooks for repositories. type: object @@ -91169,7 +91365,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &923 + last_response: &925 title: Hook Response type: object properties: @@ -91241,10 +91437,10 @@ paths: operationId: repos/create-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: false content: @@ -91267,7 +91463,7 @@ paths: insecure_ssl: *11 events: type: array - description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) + description: Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. default: - push @@ -91296,9 +91492,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *664 examples: - default: &663 + default: &665 value: type: Repository id: 12345678 @@ -91344,19 +91540,19 @@ paths: operationId: repos/get-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 responses: '200': description: Response content: application/json: - schema: *662 + schema: *664 examples: - default: *663 + default: *665 '404': *6 x-github: githubCloudOnly: false @@ -91374,11 +91570,11 @@ paths: operationId: repos/update-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 requestBody: required: true content: @@ -91389,7 +91585,7 @@ paths: config: *12 events: type: array - description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) + description: Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. default: - push @@ -91423,9 +91619,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *664 examples: - default: *663 + default: *665 '422': *15 '404': *6 x-github: @@ -91444,11 +91640,11 @@ paths: operationId: repos/delete-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 responses: '204': description: Response @@ -91470,11 +91666,11 @@ paths: operationId: repos/get-webhook-config-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 responses: '200': description: Response @@ -91499,11 +91695,11 @@ paths: operationId: repos/update-webhook-config-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 requestBody: required: false content: @@ -91545,14 +91741,14 @@ paths: operationId: repos/list-webhook-deliveries externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *478 - - *479 - - *360 - - *17 - - *361 + - *480 + - *481 - *362 + - *17 + - *363 + - *364 responses: '200': description: Response @@ -91560,9 +91756,9 @@ paths: application/json: schema: type: array - items: *363 + items: *365 examples: - default: *364 + default: *366 '400': *14 '422': *15 x-github: @@ -91579,20 +91775,20 @@ paths: operationId: repos/get-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 - *16 responses: '200': description: Response content: application/json: - schema: *365 + schema: *367 examples: - default: *366 + default: *368 '400': *14 '422': *15 x-github: @@ -91609,11 +91805,11 @@ paths: operationId: repos/redeliver-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 - *16 responses: '202': *39 @@ -91627,18 +91823,18 @@ paths: "/repos/{owner}/{repo}/hooks/{hook_id}/pings": post: summary: Ping a repository webhook - description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) + description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest/webhooks/#ping-event) to be sent to the hook. tags: - repos operationId: repos/ping-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 responses: '204': description: Response @@ -91661,11 +91857,11 @@ paths: operationId: repos/test-push-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *478 - - *479 - - *360 + - *480 + - *481 + - *362 responses: '204': description: Response @@ -91686,10 +91882,10 @@ paths: operationId: repos/check-immutable-releases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response if immutable releases are enabled @@ -91733,10 +91929,10 @@ paths: operationId: repos/enable-immutable-releases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': *130 '409': *121 @@ -91754,10 +91950,10 @@ paths: operationId: repos/disable-immutable-releases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': *130 '409': *121 @@ -91789,11 +91985,11 @@ paths: If there are problems, you will see one of these in the `status` field: - * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. + * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section. * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. - * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. - * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL. - * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. + * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section. + * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import) with the correct URL. + * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section. **The project_choices field** @@ -91812,16 +92008,16 @@ paths: operationId: migrations/get-import-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: &664 + schema: &666 title: Import description: A repository import from an external source. type: object @@ -91920,7 +92116,7 @@ paths: - html_url - authors_url examples: - default: &667 + default: &669 value: vcs: subversion use_lfs: true @@ -91936,7 +92132,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &665 + '503': &667 description: Unavailable due to service under maintenance. content: application/json: @@ -91963,10 +92159,10 @@ paths: operationId: migrations/start-import externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -92014,7 +92210,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *666 examples: default: value: @@ -92039,7 +92235,7 @@ paths: type: string '422': *15 '404': *6 - '503': *665 + '503': *667 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92065,10 +92261,10 @@ paths: operationId: migrations/update-import externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: false content: @@ -92117,7 +92313,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *666 examples: example-1: summary: Example 1 @@ -92165,7 +92361,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *665 + '503': *667 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92186,14 +92382,14 @@ paths: operationId: migrations/cancel-import externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response - '503': *665 + '503': *667 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92208,7 +92404,7 @@ paths: description: |- Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. - This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. + This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). @@ -92217,11 +92413,11 @@ paths: operationId: migrations/get-commit-authors externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors parameters: - - *478 - - *479 - - &849 + - *480 + - *481 + - &851 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -92235,7 +92431,7 @@ paths: application/json: schema: type: array - items: &666 + items: &668 title: Porter Author description: Porter Author type: object @@ -92289,7 +92485,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *665 + '503': *667 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92312,10 +92508,10 @@ paths: operationId: migrations/map-commit-author externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author parameters: - - *478 - - *479 + - *480 + - *481 - name: author_id in: path required: true @@ -92345,7 +92541,7 @@ paths: description: Response content: application/json: - schema: *666 + schema: *668 examples: default: value: @@ -92358,7 +92554,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *665 + '503': *667 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92380,10 +92576,10 @@ paths: operationId: migrations/get-large-files externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -92424,7 +92620,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *665 + '503': *667 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92441,7 +92637,7 @@ paths: is powered by [Git LFS](https://git-lfs.com). You can learn more about our LFS feature and working with large files [on our help - site](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files). + site](https://docs.github.com/enterprise-cloud@latest/repositories/working-with-files/managing-large-files). > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). @@ -92450,10 +92646,10 @@ paths: operationId: migrations/set-lfs-preference externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -92480,11 +92676,11 @@ paths: description: Response content: application/json: - schema: *664 + schema: *666 examples: - default: *667 + default: *669 '422': *15 - '503': *665 + '503': *667 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92499,16 +92695,16 @@ paths: description: |- Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-repo-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -92516,8 +92712,8 @@ paths: application/json: schema: *22 examples: - default: *378 - '301': *484 + default: *380 + '301': *486 '404': *6 x-github: githubCloudOnly: false @@ -92535,10 +92731,10 @@ paths: operationId: interactions/get-restrictions-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -92546,12 +92742,12 @@ paths: application/json: schema: anyOf: - - *380 + - *382 - type: object properties: {} additionalProperties: false examples: - default: &669 + default: &671 value: limit: collaborators_only origin: repository @@ -92574,15 +92770,15 @@ paths: operationId: interactions/set-restrictions-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: application/json: - schema: *668 + schema: *670 examples: default: summary: Example request body @@ -92594,9 +92790,9 @@ paths: description: Response content: application/json: - schema: *380 + schema: *382 examples: - default: *669 + default: *671 '409': description: Response x-github: @@ -92616,10 +92812,10 @@ paths: operationId: interactions/remove-restrictions-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -92640,10 +92836,10 @@ paths: operationId: repos/list-invitations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -92653,9 +92849,9 @@ paths: application/json: schema: type: array - items: *670 + items: *672 examples: - default: &842 + default: &844 value: - id: 1 repository: @@ -92784,11 +92980,11 @@ paths: operationId: repos/update-invitation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *478 - - *479 - - *384 + - *480 + - *481 + - *386 requestBody: required: false content: @@ -92817,7 +93013,7 @@ paths: description: Response content: application/json: - schema: *670 + schema: *672 examples: default: value: @@ -92946,11 +93142,11 @@ paths: operationId: repos/delete-invitation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *478 - - *479 - - *384 + - *480 + - *481 + - *386 responses: '204': description: Response @@ -92966,9 +93162,9 @@ paths: List issues in a repository. Only open issues will be listed. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -92979,10 +93175,10 @@ paths: operationId: issues/list-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues parameters: - - *478 - - *479 + - *480 + - *481 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -93030,7 +93226,7 @@ paths: required: false schema: type: string - - *391 + - *393 - name: sort description: What to sort results by. in: query @@ -93043,7 +93239,7 @@ paths: - comments default: created - *112 - - *234 + - *236 - *17 - *19 responses: @@ -93053,9 +93249,9 @@ paths: application/json: schema: type: array - items: *227 + items: *229 examples: - default: &682 + default: &684 value: - id: 1 node_id: MDU6SXNzdWUx @@ -93204,7 +93400,7 @@ paths: state_reason: completed headers: Link: *47 - '301': *484 + '301': *486 '422': *15 '404': *6 x-github: @@ -93215,12 +93411,12 @@ paths: 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://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. + Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest/articles/disabling-issues/), the API returns a `410 Gone` status. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93231,10 +93427,10 @@ paths: operationId: issues/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -93316,9 +93512,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: &679 + default: &681 value: id: 1 node_id: MDU6SXNzdWUx @@ -93473,9 +93669,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *198 + '503': *200 '404': *6 - '410': *671 + '410': *673 x-github: triggersNotification: true githubCloudOnly: false @@ -93490,7 +93686,7 @@ paths: By default, issue comments are ordered by ascending ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93501,11 +93697,11 @@ paths: operationId: issues/list-comments-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *478 - - *479 - - *251 + - *480 + - *481 + - *253 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -93515,7 +93711,7 @@ paths: enum: - asc - desc - - *234 + - *236 - *17 - *19 responses: @@ -93525,9 +93721,9 @@ paths: application/json: schema: type: array - items: *672 + items: *674 examples: - default: &681 + default: &683 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -93572,7 +93768,7 @@ paths: description: |- You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93583,19 +93779,19 @@ paths: operationId: issues/get-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 responses: '200': description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: &673 + default: &675 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -93637,7 +93833,7 @@ paths: description: |- You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93648,11 +93844,11 @@ paths: operationId: issues/update-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 requestBody: required: true content: @@ -93674,9 +93870,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: *673 + default: *675 '422': *15 x-github: githubCloudOnly: false @@ -93692,11 +93888,11 @@ paths: operationId: issues/delete-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 responses: '204': description: Response @@ -93711,7 +93907,7 @@ paths: description: |- You can use the REST API to pin comments on issues. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93722,17 +93918,17 @@ paths: operationId: issues/pin-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#pin-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 responses: '200': description: Response content: application/json: - schema: *672 + schema: *674 examples: default: value: @@ -93788,7 +93984,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *671 + '410': *673 '422': *15 x-github: githubCloudOnly: false @@ -93803,19 +93999,19 @@ paths: operationId: issues/unpin-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#unpin-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 responses: '204': description: Response '401': *25 '403': *29 '404': *6 - '410': *671 - '503': *198 + '410': *673 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93824,19 +94020,19 @@ paths: "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": get: summary: List reactions for an issue comment - description: List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). + description: List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/list-for-issue-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. in: query required: false @@ -93860,9 +94056,9 @@ paths: application/json: schema: type: array - items: *593 + items: *595 examples: - default: *674 + default: *676 headers: Link: *47 '404': *6 @@ -93873,7 +94069,7 @@ paths: subcategory: reactions post: summary: Create reaction for an issue comment - description: Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). + description: Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. tags: @@ -93881,11 +94077,11 @@ paths: operationId: reactions/create-for-issue-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 requestBody: required: true content: @@ -93895,7 +94091,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the issue comment. enum: - "+1" @@ -93917,16 +94113,16 @@ paths: description: Reaction exists content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '201': description: Reaction created content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '422': *15 x-github: githubCloudOnly: false @@ -93940,18 +94136,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). + Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/delete-for-issue-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *478 - - *479 - - *243 - - *675 + - *480 + - *481 + - *245 + - *677 responses: '204': description: Response @@ -93969,10 +94165,10 @@ paths: operationId: issues/list-events-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -93982,7 +94178,7 @@ paths: application/json: schema: type: array - items: &678 + items: &680 title: Issue Event description: Issue Event type: object @@ -94025,8 +94221,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *676 - required: *677 + properties: *678 + required: *679 nullable: true label: title: Issue Event Label @@ -94070,7 +94266,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *317 + requested_team: *319 dismissed_review: title: Issue Event Dismissed Review type: object @@ -94135,7 +94331,7 @@ paths: required: - from - to - author_association: *224 + author_association: *226 lock_reason: type: string nullable: true @@ -94148,8 +94344,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 required: - id - node_id @@ -94332,10 +94528,10 @@ paths: operationId: issues/get-event externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event parameters: - - *478 - - *479 + - *480 + - *481 - name: event_id in: path required: true @@ -94346,7 +94542,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: default: value: @@ -94539,7 +94735,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *671 + '410': *673 '403': *29 x-github: githubCloudOnly: false @@ -94550,17 +94746,17 @@ paths: get: summary: Get an issue description: |- - The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - [transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If + The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + [transferred](https://docs.github.com/enterprise-cloud@latest/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - to the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook. + to the [`issues`](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#issues) webhook. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94571,11 +94767,11 @@ paths: operationId: issues/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue parameters: - - *478 - - *479 - - &680 + - *480 + - *481 + - &682 name: issue_number description: The number that identifies the issue. in: path @@ -94587,11 +94783,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: default: summary: Issue - value: *679 + value: *681 pinned_comment: summary: Issue with pinned comment value: @@ -94790,9 +94986,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *484 + '301': *486 '404': *6 - '410': *671 + '410': *673 '304': *37 x-github: githubCloudOnly: false @@ -94804,7 +95000,7 @@ paths: description: |- Issue owners and users with push access or Triage role can edit an issue. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94815,11 +95011,11 @@ paths: operationId: issues/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: false content: @@ -94943,15 +95139,15 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 + default: *681 '422': *15 - '503': *198 + '503': *200 '403': *29 - '301': *484 + '301': *486 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94967,11 +95163,11 @@ paths: operationId: issues/add-assignees externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: false content: @@ -94997,9 +95193,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95013,11 +95209,11 @@ paths: operationId: issues/remove-assignees externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: content: application/json: @@ -95042,9 +95238,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95064,11 +95260,11 @@ paths: operationId: issues/check-user-can-be-assigned-to-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - name: assignee in: path required: true @@ -95095,7 +95291,7 @@ paths: Issue comments are ordered by ascending ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95106,12 +95302,12 @@ paths: operationId: issues/list-comments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments parameters: - - *478 - - *479 - - *680 - - *234 + - *480 + - *481 + - *682 + - *236 - *17 - *19 responses: @@ -95121,13 +95317,13 @@ paths: application/json: schema: type: array - items: *672 + items: *674 examples: - default: *681 + default: *683 headers: Link: *47 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95138,12 +95334,12 @@ paths: description: |- You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). + 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. - For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95154,11 +95350,11 @@ paths: operationId: issues/create-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: true content: @@ -95180,16 +95376,16 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: *673 + default: *675 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *671 + '410': *673 '422': *15 '404': *6 x-github: @@ -95204,7 +95400,7 @@ paths: description: |- You can use the REST API to list the dependencies an issue is blocked by. - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. @@ -95215,11 +95411,11 @@ paths: operationId: issues/list-dependencies-blocked-by externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - *17 - *19 responses: @@ -95229,14 +95425,14 @@ paths: application/json: schema: type: array - items: *227 + items: *229 examples: - default: *682 + default: *684 headers: Link: *47 - '301': *484 + '301': *486 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95248,10 +95444,10 @@ paths: You can use the REST API to add a 'blocked by' relationship to an issue. Creating content too quickly using this endpoint may result in secondary rate limiting. - For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) - and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api). - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. @@ -95262,11 +95458,11 @@ paths: operationId: issues/add-blocked-by-dependency externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: true content: @@ -95288,17 +95484,17 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 + default: *681 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *484 + '301': *486 '403': *29 - '410': *671 + '410': *673 '422': *15 '404': *6 x-github: @@ -95314,10 +95510,10 @@ paths: You can use the REST API to remove a dependency that an issue is blocked by. Removing content too quickly using this endpoint may result in secondary rate limiting. - For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) - and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api). - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. @@ -95327,11 +95523,11 @@ paths: operationId: issues/remove-dependency-blocked-by externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -95343,15 +95539,15 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 - '301': *484 + default: *681 + '301': *486 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *671 + '410': *673 x-github: triggersNotification: true githubCloudOnly: false @@ -95364,7 +95560,7 @@ paths: description: |- You can use the REST API to list the dependencies an issue is blocking. - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. @@ -95375,11 +95571,11 @@ paths: operationId: issues/list-dependencies-blocking externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - *17 - *19 responses: @@ -95389,14 +95585,14 @@ paths: application/json: schema: type: array - items: *227 + items: *229 examples: - default: *682 + default: *684 headers: Link: *47 - '301': *484 + '301': *486 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95411,11 +95607,11 @@ paths: operationId: issues/list-events externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - *17 - *19 responses: @@ -95429,7 +95625,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &686 + - &688 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -95460,8 +95656,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 label: type: object properties: @@ -95483,7 +95679,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &687 + - &689 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -95514,8 +95710,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 label: type: object properties: @@ -95603,8 +95799,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 assignee: *4 assigner: *4 required: @@ -95619,7 +95815,7 @@ paths: - performed_via_github_app - assignee - assigner - - &688 + - &690 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -95650,8 +95846,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 milestone: type: object properties: @@ -95670,7 +95866,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &689 + - &691 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -95701,8 +95897,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 milestone: type: object properties: @@ -95721,7 +95917,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &690 + - &692 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -95752,8 +95948,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 rename: type: object properties: @@ -95775,7 +95971,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &691 + - &693 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -95806,10 +96002,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 review_requester: *4 - requested_team: *317 + requested_team: *319 requested_reviewer: *4 required: - review_requester @@ -95822,7 +96018,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &692 + - &694 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -95853,10 +96049,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 review_requester: *4 - requested_team: *317 + requested_team: *319 requested_reviewer: *4 required: - review_requester @@ -95869,7 +96065,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &693 + - &695 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -95900,8 +96096,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 dismissed_review: type: object properties: @@ -95929,7 +96125,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &694 + - &696 title: Locked Issue Event description: Locked Issue Event type: object @@ -95960,8 +96156,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 lock_reason: type: string example: '"off-topic"' @@ -95977,7 +96173,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &695 + - &697 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -96008,8 +96204,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 project_card: type: object properties: @@ -96043,7 +96239,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &696 + - &698 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -96074,8 +96270,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 project_card: type: object properties: @@ -96109,7 +96305,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &697 + - &699 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -96140,8 +96336,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 project_card: type: object properties: @@ -96175,7 +96371,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &698 + - &700 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -96266,7 +96462,7 @@ paths: color: red headers: Link: *47 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96281,11 +96477,11 @@ paths: operationId: issues/list-issue-field-values-for-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#list-issue-field-values-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - *17 - *19 responses: @@ -96295,9 +96491,9 @@ paths: application/json: schema: type: array - items: *683 + items: *685 examples: - default: &684 + default: &686 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -96321,9 +96517,9 @@ paths: value: '2025-12-25' headers: Link: *47 - '301': *484 + '301': *486 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96343,18 +96539,18 @@ paths: Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - issues operationId: issues/add-issue-field-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: true content: @@ -96418,14 +96614,14 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *683 + items: *685 examples: - default: *684 + default: *686 '400': *14 '403': *29 '404': *6 '422': *15 - '503': *198 + '503': *200 x-github: triggersNotification: true githubCloudOnly: false @@ -96447,18 +96643,18 @@ paths: Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - issues operationId: issues/set-issue-field-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: true content: @@ -96523,14 +96719,14 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *683 + items: *685 examples: - default: *684 + default: *686 '400': *14 '403': *29 '404': *6 '422': *15 - '503': *198 + '503': *200 x-github: triggersNotification: true githubCloudOnly: false @@ -96547,26 +96743,26 @@ paths: If the specified field does not have a value set on the issue, this operation will return a `404` error. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - issues operationId: issues/delete-issue-field-value externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *478 - - *479 - - *680 - - *387 + - *480 + - *481 + - *682 + - *389 responses: '204': description: Issue field value deleted successfully '403': *29 '404': *6 '422': *15 - '503': *198 + '503': *200 x-github: triggersNotification: true githubCloudOnly: false @@ -96582,11 +96778,11 @@ paths: operationId: issues/list-labels-on-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - *17 - *19 responses: @@ -96596,9 +96792,9 @@ paths: application/json: schema: type: array - items: *226 + items: *228 examples: - default: &685 + default: &687 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -96616,9 +96812,9 @@ paths: default: false headers: Link: *47 - '301': *484 + '301': *486 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96632,11 +96828,11 @@ paths: operationId: issues/add-labels externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: false content: @@ -96652,7 +96848,7 @@ paths: labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for - an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue)." + an issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue)." items: type: string - type: array @@ -96679,12 +96875,12 @@ paths: application/json: schema: type: array - items: *226 + items: *228 examples: - default: *685 - '301': *484 + default: *687 + '301': *486 '404': *6 - '410': *671 + '410': *673 '422': *15 x-github: githubCloudOnly: false @@ -96699,11 +96895,11 @@ paths: operationId: issues/set-labels externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: false content: @@ -96721,7 +96917,7 @@ paths: a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. - For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue)." + For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue)." items: type: string - type: array @@ -96763,12 +96959,12 @@ paths: application/json: schema: type: array - items: *226 + items: *228 examples: - default: *685 - '301': *484 + default: *687 + '301': *486 '404': *6 - '410': *671 + '410': *673 '422': *15 x-github: githubCloudOnly: false @@ -96783,17 +96979,17 @@ paths: operationId: issues/remove-all-labels externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 responses: '204': description: Response - '301': *484 + '301': *486 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96810,11 +97006,11 @@ paths: operationId: issues/remove-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - name: name in: path required: true @@ -96827,7 +97023,7 @@ paths: application/json: schema: type: array - items: *226 + items: *228 examples: default: value: @@ -96838,9 +97034,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *484 + '301': *486 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96852,17 +97048,17 @@ paths: description: |- Users with push access can lock an issue or pull request's conversation. - Note 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note 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 method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - issues operationId: issues/lock externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: false content: @@ -96890,7 +97086,7 @@ paths: '204': description: Response '403': *29 - '410': *671 + '410': *673 '404': *6 '422': *15 x-github: @@ -96906,11 +97102,11 @@ paths: operationId: issues/unlock externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 responses: '204': description: Response @@ -96927,7 +97123,7 @@ paths: description: |- You can use the REST API to get the parent issue of a sub-issue. - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96938,22 +97134,22 @@ paths: operationId: issues/get-parent externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 responses: '200': description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 - '301': *484 + default: *681 + '301': *486 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96962,19 +97158,19 @@ paths: "/repos/{owner}/{repo}/issues/{issue_number}/reactions": get: summary: List reactions for an issue - description: List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). + description: List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/list-for-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. in: query required: false @@ -96998,13 +97194,13 @@ paths: application/json: schema: type: array - items: *593 + items: *595 examples: - default: *674 + default: *676 headers: Link: *47 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97012,7 +97208,7 @@ paths: subcategory: reactions post: summary: Create reaction for an issue - description: Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). + description: Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. tags: @@ -97020,11 +97216,11 @@ paths: operationId: reactions/create-for-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: true content: @@ -97034,7 +97230,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the issue. enum: - "+1" @@ -97056,16 +97252,16 @@ paths: description: Response content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '201': description: Response content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '422': *15 x-github: githubCloudOnly: false @@ -97079,18 +97275,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). + Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/delete-for-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *478 - - *479 - - *680 - - *675 + - *480 + - *481 + - *682 + - *677 responses: '204': description: Response @@ -97105,9 +97301,9 @@ paths: description: |- You can use the REST API to remove a sub-issue from an issue. Removing content too quickly using this endpoint may result in secondary rate limiting. - For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. @@ -97117,11 +97313,11 @@ paths: operationId: issues/remove-sub-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: true content: @@ -97143,9 +97339,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 + default: *681 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -97165,7 +97361,7 @@ paths: description: |- You can use the REST API to list the sub-issues on an issue. - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. @@ -97176,11 +97372,11 @@ paths: operationId: issues/list-sub-issues externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - *17 - *19 responses: @@ -97190,13 +97386,13 @@ paths: application/json: schema: type: array - items: *227 + items: *229 examples: - default: *682 + default: *684 headers: Link: *47 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97208,10 +97404,10 @@ paths: You can use the REST API to add sub-issues to issues. Creating content too quickly using this endpoint may result in secondary rate limiting. - For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97222,11 +97418,11 @@ paths: operationId: issues/add-sub-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: true content: @@ -97253,16 +97449,16 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 + default: *681 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *671 + '410': *673 '422': *15 '404': *6 x-github: @@ -97280,11 +97476,11 @@ paths: operationId: issues/reprioritize-sub-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 requestBody: required: true content: @@ -97315,13 +97511,13 @@ paths: description: Response content: application/json: - schema: *227 + schema: *229 examples: - default: *679 + default: *681 '403': *29 '404': *6 '422': *7 - '503': *198 + '503': *200 x-github: triggersNotification: true githubCloudOnly: false @@ -97337,11 +97533,11 @@ paths: operationId: issues/list-events-for-timeline externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *478 - - *479 - - *680 + - *480 + - *481 + - *682 - *17 - *19 responses: @@ -97356,8 +97552,6 @@ paths: description: Timeline Event type: object anyOf: - - *686 - - *687 - *688 - *689 - *690 @@ -97369,6 +97563,8 @@ paths: - *696 - *697 - *698 + - *699 + - *700 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -97411,7 +97607,7 @@ paths: issue_url: type: string format: uri - author_association: *224 + author_association: *226 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -97421,16 +97617,16 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 - reactions: *225 + properties: *224 + required: *225 + reactions: *227 pin: title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *699 - required: *700 + properties: *701 + required: *702 nullable: true required: - event @@ -97462,7 +97658,7 @@ paths: properties: type: type: string - issue: *227 + issue: *229 required: - event - created_at @@ -97662,7 +97858,7 @@ paths: type: string body_text: type: string - author_association: *224 + author_association: *226 required: - event - id @@ -97685,7 +97881,7 @@ paths: type: string comments: type: array - items: &722 + items: &724 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -97780,7 +97976,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *224 + author_association: *226 _links: type: object properties: @@ -97864,7 +98060,7 @@ paths: enum: - line - file - reactions: *225 + reactions: *227 body_html: type: string example: '"

comment body

"' @@ -97900,7 +98096,7 @@ paths: type: string comments: type: array - items: *592 + items: *594 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -97931,8 +98127,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 assignee: *4 required: - id @@ -97975,8 +98171,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 assignee: *4 required: - id @@ -98019,8 +98215,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 state_reason: type: string nullable: true @@ -98189,7 +98385,7 @@ paths: headers: Link: *47 '404': *6 - '410': *671 + '410': *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98204,10 +98400,10 @@ paths: operationId: repos/list-deploy-keys externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys + url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -98217,7 +98413,7 @@ paths: application/json: schema: type: array - items: &701 + items: &703 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -98281,10 +98477,10 @@ paths: operationId: repos/create-deploy-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key + url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -98305,8 +98501,8 @@ paths: \ \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository - permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)\" - and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/).\"" + permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/articles/repository-permission-levels-for-an-organization/)\" + and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest/articles/permission-levels-for-a-user-account-repository/).\"" required: - key examples: @@ -98320,9 +98516,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *703 examples: - default: &702 + default: &704 value: id: 1 key: ssh-rsa AAA... @@ -98354,11 +98550,11 @@ paths: operationId: repos/get-deploy-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key + url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *478 - - *479 - - &703 + - *480 + - *481 + - &705 name: key_id description: The unique identifier of the key. in: path @@ -98370,9 +98566,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *703 examples: - default: *702 + default: *704 '404': *6 x-github: githubCloudOnly: false @@ -98388,11 +98584,11 @@ paths: operationId: repos/delete-deploy-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key + url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *478 - - *479 - - *703 + - *480 + - *481 + - *705 responses: '204': description: Response @@ -98410,10 +98606,10 @@ paths: operationId: issues/list-labels-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -98423,9 +98619,9 @@ paths: application/json: schema: type: array - items: *226 + items: *228 examples: - default: *685 + default: *687 headers: Link: *47 '404': *6 @@ -98444,10 +98640,10 @@ paths: operationId: issues/create-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -98483,9 +98679,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *228 examples: - default: &704 + default: &706 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -98515,10 +98711,10 @@ paths: operationId: issues/get-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label parameters: - - *478 - - *479 + - *480 + - *481 - name: name in: path required: true @@ -98529,9 +98725,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *228 examples: - default: *704 + default: *706 '404': *6 x-github: githubCloudOnly: false @@ -98546,10 +98742,10 @@ paths: operationId: issues/update-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label parameters: - - *478 - - *479 + - *480 + - *481 - name: name in: path required: true @@ -98588,7 +98784,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *228 examples: default: value: @@ -98612,10 +98808,10 @@ paths: operationId: issues/delete-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label parameters: - - *478 - - *479 + - *480 + - *481 - name: name in: path required: true @@ -98639,10 +98835,10 @@ paths: operationId: repos/list-languages externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -98676,10 +98872,10 @@ paths: - repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '202': *39 '403': @@ -98705,10 +98901,10 @@ paths: - repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -98723,7 +98919,7 @@ paths: description: |- This method returns the contents of the repository's license file, if one is detected. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -98732,11 +98928,11 @@ paths: operationId: licenses/get-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *478 - - *479 - - *565 + - *480 + - *481 + - *567 responses: '200': description: Response @@ -98798,8 +98994,8 @@ paths: title: License Simple description: License Simple type: object - properties: *230 - required: *231 + properties: *232 + required: *233 nullable: true required: - _links @@ -98879,10 +99075,10 @@ paths: operationId: repos/merge-upstream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -98945,10 +99141,10 @@ paths: operationId: repos/merge externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -98982,9 +99178,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *595 + schema: *597 examples: - default: *705 + default: *707 '204': description: Response when already merged '404': @@ -99007,10 +99203,10 @@ paths: operationId: issues/list-milestones externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones parameters: - - *478 - - *479 + - *480 + - *481 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -99051,12 +99247,12 @@ paths: application/json: schema: type: array - items: &706 + items: &708 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *423 - required: *424 + properties: *425 + required: *426 examples: default: value: @@ -99110,10 +99306,10 @@ paths: operationId: issues/create-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -99153,9 +99349,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: &707 + default: &709 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -99212,11 +99408,11 @@ paths: operationId: issues/get-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone parameters: - - *478 - - *479 - - &708 + - *480 + - *481 + - &710 name: milestone_number description: The number that identifies the milestone. in: path @@ -99228,9 +99424,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *707 + default: *709 '404': *6 x-github: githubCloudOnly: false @@ -99245,11 +99441,11 @@ paths: operationId: issues/update-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone parameters: - - *478 - - *479 - - *708 + - *480 + - *481 + - *710 requestBody: required: false content: @@ -99287,9 +99483,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *707 + default: *709 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99303,11 +99499,11 @@ paths: operationId: issues/delete-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone parameters: - - *478 - - *479 - - *708 + - *480 + - *481 + - *710 responses: '204': description: Response @@ -99326,11 +99522,11 @@ paths: operationId: issues/list-labels-for-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *478 - - *479 - - *708 + - *480 + - *481 + - *710 - *17 - *19 responses: @@ -99340,9 +99536,9 @@ paths: application/json: schema: type: array - items: *226 + items: *228 examples: - default: *685 + default: *687 headers: Link: *47 x-github: @@ -99359,14 +99555,14 @@ paths: operationId: activity/list-repo-notifications-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *478 - - *479 - - *709 - - *710 - - *234 + - *480 + - *481 - *711 + - *712 + - *236 + - *713 - *17 - *19 responses: @@ -99376,9 +99572,9 @@ paths: application/json: schema: type: array - items: *254 + items: *256 examples: - default: *712 + default: *714 headers: Link: *47 x-github: @@ -99393,17 +99589,17 @@ paths: you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications - for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) + for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity operationId: activity/mark-repo-notifications-as-read externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: false content: @@ -99459,16 +99655,16 @@ paths: operationId: repos/get-pages externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: &713 + schema: &715 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -99593,7 +99789,7 @@ paths: - custom_404 - public examples: - default: &714 + default: &716 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -99632,10 +99828,10 @@ paths: operationId: repos/create-pages-site externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -99689,9 +99885,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *715 examples: - default: *714 + default: *716 '422': *15 '409': *121 x-github: @@ -99712,10 +99908,10 @@ paths: operationId: repos/update-information-about-pages-site externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -99727,7 +99923,7 @@ paths: type: string 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://docs.github.com/enterprise-cloud@latest//pages/configuring-a-custom-domain-for-your-github-pages-site)." + domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest/pages/configuring-a-custom-domain-for-your-github-pages-site)." nullable: true https_enforced: type: boolean @@ -99820,10 +100016,10 @@ paths: operationId: repos/delete-pages-site externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -99847,10 +100043,10 @@ paths: operationId: repos/list-pages-builds externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -99860,7 +100056,7 @@ paths: application/json: schema: type: array - items: &715 + items: &717 title: Page Build description: Page Build type: object @@ -99952,10 +100148,10 @@ paths: operationId: repos/request-pages-build externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build parameters: - - *478 - - *479 + - *480 + - *481 responses: '201': description: Response @@ -99998,18 +100194,18 @@ paths: operationId: repos/get-latest-pages-build externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *715 + schema: *717 examples: - default: &716 + default: &718 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -100055,10 +100251,10 @@ paths: operationId: repos/get-pages-build externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build parameters: - - *478 - - *479 + - *480 + - *481 - name: build_id in: path required: true @@ -100069,9 +100265,9 @@ paths: description: Response content: application/json: - schema: *715 + schema: *717 examples: - default: *716 + default: *718 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100089,10 +100285,10 @@ paths: operationId: repos/create-pages-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -100195,11 +100391,11 @@ paths: operationId: repos/get-pages-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *478 - - *479 - - &717 + - *480 + - *481 + - &719 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -100255,11 +100451,11 @@ paths: operationId: repos/cancel-pages-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *478 - - *479 - - *717 + - *480 + - *481 + - *719 responses: '204': *130 '404': *6 @@ -100284,10 +100480,10 @@ paths: operationId: repos/get-pages-health-check externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -100518,7 +100714,7 @@ paths: description: Empty response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -100537,16 +100733,16 @@ paths: summary: Check if private vulnerability reporting is enabled for a repository description: Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating - the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + the security settings of a repository](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". tags: - repos operationId: repos/check-private-vulnerability-reporting externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Private vulnerability reporting status @@ -100575,16 +100771,16 @@ paths: summary: Enable private vulnerability reporting for a repository description: Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately - reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." tags: - repos operationId: repos/enable-private-vulnerability-reporting externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': *130 '422': *14 @@ -100597,16 +100793,16 @@ paths: summary: Disable private vulnerability reporting for a repository description: Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, - see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". tags: - repos operationId: repos/disable-private-vulnerability-reporting externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': *130 '422': *14 @@ -100626,10 +100822,10 @@ paths: operationId: repos/custom-properties-for-repos-get-repository-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -100637,9 +100833,9 @@ paths: application/json: schema: type: array - items: *158 + items: *160 examples: - default: *718 + default: *720 '403': *29 '404': *6 x-github: @@ -100659,10 +100855,10 @@ paths: operationId: repos/custom-properties-for-repos-create-or-update-repository-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -100674,11 +100870,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *158 + items: *160 required: - properties examples: - default: *719 + default: *721 responses: '204': description: No Content when custom property values are successfully created @@ -100700,10 +100896,10 @@ paths: 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://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -100714,10 +100910,10 @@ paths: operationId: pulls/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests parameters: - - *478 - - *479 + - *480 + - *481 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -100777,9 +100973,9 @@ paths: application/json: schema: type: array - items: *599 + items: *601 examples: - default: *720 + default: *722 headers: Link: *47 '304': *37 @@ -100792,13 +100988,13 @@ paths: 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://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + 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://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To 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. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -100809,10 +101005,10 @@ paths: operationId: pulls/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -100847,12 +101043,12 @@ paths: description: The contents of the pull request. maintainer_can_modify: type: boolean - description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) + description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. draft: type: boolean description: Indicates whether the pull request is a draft. See - "[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest//articles/about-pull-requests#draft-pull-requests)" + "[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. issue: type: integer @@ -100877,7 +101073,7 @@ paths: description: Response content: application/json: - schema: &724 + schema: &726 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -100988,8 +101184,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *423 - required: *424 + properties: *425 + required: *426 nullable: true active_lock_reason: type: string @@ -101032,7 +101228,7 @@ paths: items: *4 requested_teams: type: array - items: *462 + items: *464 head: type: object properties: @@ -101070,14 +101266,14 @@ paths: _links: type: object properties: - comments: *425 - commits: *425 - statuses: *425 - html: *425 - issue: *425 - review_comments: *425 - review_comment: *425 - self: *425 + comments: *427 + commits: *427 + statuses: *427 + html: *427 + issue: *427 + review_comments: *427 + review_comment: *427 + self: *427 required: - comments - commits @@ -101087,8 +101283,8 @@ paths: - review_comments - review_comment - self - author_association: *224 - auto_merge: *721 + author_association: *226 + auto_merge: *723 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -101180,7 +101376,7 @@ paths: - merged_by - review_comments examples: - default: &725 + default: &727 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -101694,7 +101890,7 @@ paths: Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -101705,10 +101901,10 @@ paths: operationId: pulls/list-review-comments-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *478 - - *479 + - *480 + - *481 - name: sort in: query required: false @@ -101727,7 +101923,7 @@ paths: enum: - asc - desc - - *234 + - *236 - *17 - *19 responses: @@ -101737,9 +101933,9 @@ paths: application/json: schema: type: array - items: *722 + items: *724 examples: - default: &727 + default: &729 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -101803,7 +101999,7 @@ paths: description: |- Provides details for a specified review comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -101814,19 +102010,19 @@ paths: operationId: pulls/get-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 responses: '200': description: Response content: application/json: - schema: *722 + schema: *724 examples: - default: &723 + default: &725 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -101888,7 +102084,7 @@ paths: description: |- Edits the content of a specified review comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -101899,11 +102095,11 @@ paths: operationId: pulls/update-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 requestBody: required: true content: @@ -101925,9 +102121,9 @@ paths: description: Response content: application/json: - schema: *722 + schema: *724 examples: - default: *723 + default: *725 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101941,11 +102137,11 @@ paths: operationId: pulls/delete-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 responses: '204': description: Response @@ -101958,19 +102154,19 @@ paths: "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": get: summary: List reactions for a pull request review comment - description: List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). + description: List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/list-for-pull-request-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. in: query required: false @@ -101994,9 +102190,9 @@ paths: application/json: schema: type: array - items: *593 + items: *595 examples: - default: *674 + default: *676 headers: Link: *47 '404': *6 @@ -102007,7 +102203,7 @@ paths: subcategory: reactions post: summary: Create reaction for a pull request review comment - description: Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). + description: Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. tags: @@ -102015,11 +102211,11 @@ paths: operationId: reactions/create-for-pull-request-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *478 - - *479 - - *243 + - *480 + - *481 + - *245 requestBody: required: true content: @@ -102029,7 +102225,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the pull request review comment. enum: - "+1" @@ -102051,16 +102247,16 @@ paths: description: Reaction exists content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '201': description: Reaction created content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '422': *15 x-github: githubCloudOnly: false @@ -102074,18 +102270,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). + Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/delete-for-pull-request-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *478 - - *479 - - *243 - - *675 + - *480 + - *481 + - *245 + - *677 responses: '204': description: Response @@ -102098,23 +102294,23 @@ paths: get: summary: Get 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://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + 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://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists details of a pull request by providing its number. - When you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + When you get, [create](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * If [rebased](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. + Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -102126,11 +102322,11 @@ paths: operationId: pulls/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request parameters: - - *478 - - *479 - - &726 + - *480 + - *481 + - &728 name: pull_number description: The number that identifies the pull request. in: path @@ -102139,13 +102335,13 @@ paths: type: integer responses: '200': - description: Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) + description: Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. content: application/json: - schema: *724 + schema: *726 examples: - default: *725 + default: *727 '304': *37 '404': *6 '406': @@ -102154,7 +102350,7 @@ paths: application/json: schema: *3 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102163,11 +102359,11 @@ paths: patch: summary: Update 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://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + 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://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To 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. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -102178,11 +102374,11 @@ paths: operationId: pulls/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 requestBody: required: false content: @@ -102210,7 +102406,7 @@ paths: another repository. maintainer_can_modify: type: boolean - description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) + description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. examples: default: @@ -102224,9 +102420,9 @@ paths: description: Response content: application/json: - schema: *724 + schema: *726 examples: - default: *725 + default: *727 '422': *15 '403': *29 x-github: @@ -102246,11 +102442,11 @@ paths: operationId: pulls/archive externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 responses: '204': description: Response @@ -102273,11 +102469,11 @@ paths: operationId: pulls/unarchive externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 responses: '204': description: Response @@ -102301,11 +102497,11 @@ paths: operationId: codespaces/create-with-pr-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 requestBody: required: true content: @@ -102365,21 +102561,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '401': *25 '403': *29 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102392,7 +102588,7 @@ paths: Lists all review comments for a specified pull request. By default, review comments are in ascending order by ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -102403,12 +102599,12 @@ paths: operationId: pulls/list-review-comments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *478 - - *479 - - *726 - - *251 + - *480 + - *481 + - *728 + - *253 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -102418,7 +102614,7 @@ paths: enum: - asc - desc - - *234 + - *236 - *17 - *19 responses: @@ -102428,9 +102624,9 @@ paths: application/json: schema: type: array - items: *722 + items: *724 examples: - default: *727 + default: *729 headers: Link: *47 x-github: @@ -102441,16 +102637,16 @@ paths: post: summary: Create a review comment for a pull request description: |- - Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment)." + Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment)." If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -102461,11 +102657,11 @@ paths: operationId: pulls/create-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 requestBody: required: true content: @@ -102506,7 +102702,7 @@ paths: that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. - For more information, see "[Diff view options](https://docs.github.com/enterprise-cloud@latest//articles/about-comparing-branches-in-pull-requests#diff-view-options)" + For more information, see "[Diff view options](https://docs.github.com/enterprise-cloud@latest/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. enum: - LEFT @@ -102522,7 +102718,7 @@ paths: description: '**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn - more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" + more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation.' start_side: type: string @@ -102530,7 +102726,7 @@ paths: `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull - request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" + request](https://docs.github.com/enterprise-cloud@latest/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context.' enum: @@ -102570,7 +102766,7 @@ paths: description: Response content: application/json: - schema: *722 + schema: *724 examples: example-for-a-multi-line-comment: value: @@ -102642,10 +102838,10 @@ paths: 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. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -102656,12 +102852,12 @@ paths: operationId: pulls/create-reply-for-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *478 - - *479 - - *726 - - *243 + - *480 + - *481 + - *728 + - *245 requestBody: required: true content: @@ -102683,7 +102879,7 @@ paths: description: Response content: application/json: - schema: *722 + schema: *724 examples: default: value: @@ -102753,10 +102949,10 @@ paths: summary: List commits on a pull request description: |- Lists a maximum of 250 commits for a pull request. To receive a complete - commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits) + commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits) endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -102767,11 +102963,11 @@ paths: operationId: pulls/list-commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 - *17 - *19 responses: @@ -102781,9 +102977,9 @@ paths: application/json: schema: type: array - items: *595 + items: *597 examples: - default: *728 + default: *730 headers: Link: *47 x-github: @@ -102800,7 +102996,7 @@ paths: > [!NOTE] > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -102811,11 +103007,11 @@ paths: operationId: pulls/list-files externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 - *17 - *19 responses: @@ -102825,7 +103021,7 @@ paths: application/json: schema: type: array - items: *608 + items: *610 examples: default: value: @@ -102844,7 +103040,7 @@ paths: Link: *47 '422': *15 '500': *40 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102861,11 +103057,11 @@ paths: operationId: pulls/check-if-merged externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 responses: '204': description: Response if pull request has been merged @@ -102880,17 +103076,17 @@ paths: summary: Merge a pull request description: |- Merges a pull request into the base branch. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - pulls operationId: pulls/merge externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 requestBody: required: false content: @@ -102992,18 +103188,18 @@ paths: description: Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews - for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request) + for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. tags: - pulls operationId: pulls/list-requested-reviewers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 responses: '200': description: Response @@ -103019,7 +103215,7 @@ paths: items: *4 teams: type: array - items: *317 + items: *319 required: - users - teams @@ -103070,17 +103266,17 @@ paths: summary: Request reviewers for a pull request description: |- Requests reviews for a pull request from a given set of users and/or teams. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - pulls operationId: pulls/request-reviewers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 requestBody: required: false content: @@ -103117,7 +103313,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *601 examples: default: value: @@ -103651,11 +103847,11 @@ paths: operationId: pulls/remove-requested-reviewers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 requestBody: required: true content: @@ -103689,7 +103885,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *601 examples: default: value: @@ -104181,7 +104377,7 @@ paths: description: |- Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104192,11 +104388,11 @@ paths: operationId: pulls/list-reviews externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 - *17 - *19 responses: @@ -104206,7 +104402,7 @@ paths: application/json: schema: type: array - items: &729 + items: &731 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -104275,7 +104471,7 @@ paths: type: string body_text: type: string - author_association: *224 + author_association: *226 required: - id - node_id @@ -104335,16 +104531,16 @@ paths: description: |- Creates a review on a specified pull request. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request)." + Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request)." > [!NOTE] - > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. + > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) endpoint. 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104355,11 +104551,11 @@ paths: operationId: pulls/create-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 requestBody: required: false content: @@ -104383,7 +104579,7 @@ paths: description: 'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, - which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request) + which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.' enum: - APPROVE @@ -104445,9 +104641,9 @@ paths: description: Response content: application/json: - schema: *729 + schema: *731 examples: - default: &731 + default: &733 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -104497,7 +104693,7 @@ paths: description: |- Retrieves a pull request review by its ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104508,12 +104704,12 @@ paths: operationId: pulls/get-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *478 - - *479 - - *726 - - &730 + - *480 + - *481 + - *728 + - &732 name: review_id description: The unique identifier of the review. in: path @@ -104525,9 +104721,9 @@ paths: description: Response content: application/json: - schema: *729 + schema: *731 examples: - default: &732 + default: &734 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -104573,7 +104769,7 @@ paths: description: |- Updates the contents of a specified review summary comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104584,12 +104780,12 @@ paths: operationId: pulls/update-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *478 - - *479 - - *726 - - *730 + - *480 + - *481 + - *728 + - *732 requestBody: required: true content: @@ -104612,7 +104808,7 @@ paths: description: Response content: application/json: - schema: *729 + schema: *731 examples: default: value: @@ -104661,7 +104857,7 @@ paths: description: |- Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104672,20 +104868,20 @@ paths: operationId: pulls/delete-pending-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *478 - - *479 - - *726 - - *730 + - *480 + - *481 + - *728 + - *732 responses: '200': description: Response content: application/json: - schema: *729 + schema: *731 examples: - default: *731 + default: *733 '422': *7 '404': *6 x-github: @@ -104699,7 +104895,7 @@ paths: description: |- Lists comments for a specific pull request review. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104710,12 +104906,12 @@ paths: operationId: pulls/list-comments-for-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *478 - - *479 - - *726 - - *730 + - *480 + - *481 + - *728 + - *732 - *17 - *19 responses: @@ -104794,13 +104990,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *224 + author_association: *226 _links: type: object properties: - self: *425 - html: *425 - pull_request: *425 + self: *427 + html: *427 + pull_request: *427 required: - self - html @@ -104809,7 +105005,7 @@ paths: type: string body_html: type: string - reactions: *225 + reactions: *227 side: description: The side of the first line of the range for a multi-line comment. @@ -104935,9 +105131,9 @@ paths: Dismisses a specified review on a pull request. > [!NOTE] - > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104948,12 +105144,12 @@ paths: operationId: pulls/dismiss-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *478 - - *479 - - *726 - - *730 + - *480 + - *481 + - *728 + - *732 requestBody: required: true content: @@ -104981,7 +105177,7 @@ paths: description: Response content: application/json: - schema: *729 + schema: *731 examples: default: value: @@ -105029,9 +105225,9 @@ paths: post: summary: Submit a review for a pull request description: |- - Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request)." + Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -105042,12 +105238,12 @@ paths: operationId: pulls/submit-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *478 - - *479 - - *726 - - *730 + - *480 + - *481 + - *728 + - *732 requestBody: required: true content: @@ -105082,9 +105278,9 @@ paths: description: Response content: application/json: - schema: *729 + schema: *731 examples: - default: *732 + default: *734 '404': *6 '422': *7 '403': *29 @@ -105104,11 +105300,11 @@ paths: operationId: pulls/update-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *478 - - *479 - - *726 + - *480 + - *481 + - *728 requestBody: required: false content: @@ -105123,7 +105319,7 @@ paths: This is the most recent commit on the pull request''s branch. If the expected SHA does not match the pull request''s HEAD, you will receive a `422 Unprocessable Entity` status. You can use - the "[List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits)" + the "[List commits](https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request''s current HEAD ref.' examples: @@ -105160,7 +105356,7 @@ paths: description: |- Gets the preferred README for a repository. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -105169,10 +105365,10 @@ paths: operationId: repos/get-readme externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme parameters: - - *478 - - *479 + - *480 + - *481 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -105185,9 +105381,9 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: &734 + default: &736 value: type: file encoding: base64 @@ -105218,7 +105414,7 @@ paths: description: |- Gets the README from a repository directory. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -105227,10 +105423,10 @@ paths: operationId: repos/get-readme-in-directory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *478 - - *479 + - *480 + - *481 - name: dir description: The alternate path to look for a README file in: path @@ -105250,9 +105446,9 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: *734 + default: *736 '404': *6 '422': *15 x-github: @@ -105264,7 +105460,7 @@ paths: get: summary: List releases description: |- - This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags). + This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags). Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. tags: @@ -105272,10 +105468,10 @@ paths: operationId: repos/list-releases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -105285,7 +105481,7 @@ paths: application/json: schema: type: array - items: *735 + items: *737 examples: default: value: @@ -105371,16 +105567,16 @@ paths: description: |- Users with push access to the repository can create a release. - 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + 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. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - repos operationId: repos/create-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -105418,7 +105614,7 @@ paths: description: If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see - "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." generate_release_notes: type: boolean description: Whether to automatically generate the name and body @@ -105456,9 +105652,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *737 examples: - default: &739 + default: &741 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -105553,7 +105749,7 @@ paths: description: "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to - \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response." tags: @@ -105561,11 +105757,11 @@ paths: operationId: repos/get-release-asset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset parameters: - - *478 - - *479 - - &737 + - *480 + - *481 + - &739 name: asset_id description: The unique identifier of the asset. in: path @@ -105577,9 +105773,9 @@ paths: description: Response content: application/json: - schema: *736 + schema: *738 examples: - default: &738 + default: &740 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -105614,7 +105810,7 @@ paths: type: User site_admin: false '404': *6 - '302': *612 + '302': *614 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105628,11 +105824,11 @@ paths: operationId: repos/update-release-asset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset parameters: - - *478 - - *479 - - *737 + - *480 + - *481 + - *739 requestBody: required: false content: @@ -105660,9 +105856,9 @@ paths: description: Response content: application/json: - schema: *736 + schema: *738 examples: - default: *738 + default: *740 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105676,11 +105872,11 @@ paths: operationId: repos/delete-release-asset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset parameters: - - *478 - - *479 - - *737 + - *480 + - *481 + - *739 responses: '204': description: Response @@ -105693,7 +105889,7 @@ paths: "/repos/{owner}/{repo}/releases/generate-notes": post: summary: Generate release notes content for a release - description: Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + description: Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when @@ -105703,10 +105899,10 @@ paths: operationId: repos/generate-release-notes externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -105789,18 +105985,18 @@ paths: operationId: repos/get-latest-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response content: application/json: - schema: *735 + schema: *737 examples: - default: *739 + default: *741 '404': *6 x-github: githubCloudOnly: false @@ -105816,10 +106012,10 @@ paths: operationId: repos/get-release-by-tag externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name parameters: - - *478 - - *479 + - *480 + - *481 - name: tag description: tag parameter in: path @@ -105832,9 +106028,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *737 examples: - default: *739 + default: *741 '404': *6 x-github: githubCloudOnly: false @@ -105848,17 +106044,17 @@ paths: Gets a public release with the specified release ID. > [!NOTE] - > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." tags: - repos operationId: repos/get-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release parameters: - - *478 - - *479 - - &740 + - *480 + - *481 + - &742 name: release_id description: The unique identifier of the release. in: path @@ -105869,12 +106065,12 @@ paths: '200': description: '**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. - For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' + For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *735 + schema: *737 examples: - default: *739 + default: *741 '401': description: Unauthorized x-github: @@ -105890,11 +106086,11 @@ paths: operationId: repos/update-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release parameters: - - *478 - - *479 - - *740 + - *480 + - *481 + - *742 requestBody: required: false content: @@ -105943,7 +106139,7 @@ paths: is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, - see "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + see "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." examples: default: value: @@ -105958,9 +106154,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *737 examples: - default: *739 + default: *741 '404': description: Not Found if the discussion category name is invalid content: @@ -105979,11 +106175,11 @@ paths: operationId: repos/delete-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release parameters: - - *478 - - *479 - - *740 + - *480 + - *481 + - *742 responses: '204': description: Response @@ -106002,11 +106198,11 @@ paths: operationId: repos/list-release-assets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets parameters: - - *478 - - *479 - - *740 + - *480 + - *481 + - *742 - *17 - *19 responses: @@ -106016,7 +106212,7 @@ paths: application/json: schema: type: array - items: *736 + items: *738 examples: default: value: @@ -106061,10 +106257,10 @@ paths: subcategory: assets post: summary: Upload a release asset - description: "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) + description: "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe - response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release) + response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header @@ -106079,11 +106275,11 @@ paths: an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* \ GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List - release assets](https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets)\"\nendpoint + release assets](https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* \ To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` - endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release). + endpoint](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset." @@ -106092,15 +106288,15 @@ paths: operationId: repos/upload-release-asset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#upload-a-release-asset + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#upload-a-release-asset servers: - url: https://uploads.github.com description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *478 - - *479 - - *740 + - *480 + - *481 + - *742 - name: name in: query required: true @@ -106126,7 +106322,7 @@ paths: description: Response for successful upload content: application/json: - schema: *736 + schema: *738 examples: response-for-successful-upload: value: @@ -106173,19 +106369,19 @@ paths: "/repos/{owner}/{repo}/releases/{release_id}/reactions": get: summary: List reactions for a release - description: List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + description: List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/list-for-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *478 - - *479 - - *740 + - *480 + - *481 + - *742 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. in: query required: false @@ -106207,9 +106403,9 @@ paths: application/json: schema: type: array - items: *593 + items: *595 examples: - default: *674 + default: *676 headers: Link: *47 '404': *6 @@ -106220,7 +106416,7 @@ paths: subcategory: reactions post: summary: Create reaction for a release - description: 'Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + description: 'Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.' tags: @@ -106228,11 +106424,11 @@ paths: operationId: reactions/create-for-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *478 - - *479 - - *740 + - *480 + - *481 + - *742 requestBody: required: true content: @@ -106242,7 +106438,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the release. enum: - "+1" @@ -106262,16 +106458,16 @@ paths: description: Reaction exists content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '201': description: Reaction created content: application/json: - schema: *593 + schema: *595 examples: - default: *594 + default: *596 '422': *15 x-github: githubCloudOnly: false @@ -106285,18 +106481,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/delete-for-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction parameters: - - *478 - - *479 - - *740 - - *675 + - *480 + - *481 + - *742 + - *677 responses: '204': description: Response @@ -106318,11 +106514,11 @@ paths: operationId: repos/get-branch-rules externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch parameters: - - *478 - - *479 - - *531 + - *480 + - *481 + - *533 - *17 - *19 responses: @@ -106338,8 +106534,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *172 - - &741 + - *174 + - &743 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -106358,69 +106554,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *173 - - *741 - - allOf: - - *174 - - *741 - allOf: - *175 - - *741 - - allOf: - - *742 - - *741 + - *743 - allOf: - *176 - - *741 + - *743 - allOf: - *177 - - *741 + - *743 + - allOf: + - *744 + - *743 - allOf: - *178 - - *741 + - *743 - allOf: - *179 - - *741 + - *743 - allOf: - *180 - - *741 + - *743 - allOf: - *181 - - *741 + - *743 - allOf: - *182 - - *741 + - *743 - allOf: - *183 - - *741 + - *743 - allOf: - *184 - - *741 + - *743 - allOf: - *185 - - *741 + - *743 - allOf: - *186 - - *741 + - *743 - allOf: - *187 - - *741 + - *743 - allOf: - *188 - - *741 + - *743 - allOf: - *189 - - *741 + - *743 - allOf: - *190 - - *741 + - *743 - allOf: - *191 - - *741 + - *743 - allOf: - *192 - - *741 + - *743 + - allOf: + - *193 + - *743 + - allOf: + - *194 + - *743 examples: default: value: @@ -106452,15 +106648,15 @@ paths: operationId: repos/get-repo-rulesets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-all-repository-rulesets x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 - name: includes_parents @@ -106471,7 +106667,7 @@ paths: schema: type: boolean default: true - - *743 + - *745 responses: '200': description: Response @@ -106479,7 +106675,7 @@ paths: application/json: schema: type: array - items: *193 + items: *195 examples: default: value: @@ -106519,15 +106715,15 @@ paths: operationId: repos/create-repo-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#create-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *478 - - *479 + - *480 + - *481 requestBody: description: Request body required: true @@ -106547,16 +106743,16 @@ paths: - tag - push default: branch - enforcement: *170 + enforcement: *172 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *171 - conditions: *164 + items: *173 + conditions: *166 rules: type: array description: An array of rules within the ruleset. - items: *744 + items: *746 required: - name - enforcement @@ -106587,9 +106783,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *195 examples: - default: &753 + default: &755 value: id: 42 name: super cool ruleset @@ -106629,20 +106825,20 @@ paths: summary: List repository rule suites description: |- Lists suites of rule evaluations at the repository level. - For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-repo-rule-suites externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *478 - - *479 - - *745 - - *107 - - *746 + - *480 + - *481 - *747 + - *107 + - *748 + - *749 - *17 - *19 responses: @@ -106650,9 +106846,9 @@ paths: description: Response content: application/json: - schema: *748 + schema: *750 examples: - default: *749 + default: *751 '404': *6 '500': *40 x-github: @@ -106665,25 +106861,25 @@ paths: summary: Get a repository rule suite description: |- Gets information about a suite of rule evaluations from within a repository. - For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-repo-rule-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *478 - - *479 - - *750 + - *480 + - *481 + - *752 responses: '200': description: Response content: application/json: - schema: *751 + schema: *753 examples: - default: *752 + default: *754 '404': *6 '500': *40 x-github: @@ -106704,15 +106900,15 @@ paths: operationId: repos/get-repo-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-a-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *478 - - *479 + - *480 + - *481 - name: ruleset_id description: The ID of the ruleset. in: path @@ -106732,9 +106928,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *195 examples: - default: *753 + default: *755 '404': *6 '500': *40 put: @@ -106745,15 +106941,15 @@ paths: operationId: repos/update-repo-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#update-a-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#update-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *478 - - *479 + - *480 + - *481 - name: ruleset_id description: The ID of the ruleset. in: path @@ -106778,16 +106974,16 @@ paths: - branch - tag - push - enforcement: *170 + enforcement: *172 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *171 - conditions: *164 + items: *173 + conditions: *166 rules: description: An array of rules within the ruleset. type: array - items: *744 + items: *746 examples: default: value: @@ -106815,9 +107011,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *195 examples: - default: *753 + default: *755 '404': *6 '422': *15 '500': *40 @@ -106829,15 +107025,15 @@ paths: operationId: repos/delete-repo-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#delete-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *478 - - *479 + - *480 + - *481 - name: ruleset_id description: The ID of the ruleset. in: path @@ -106858,10 +107054,10 @@ paths: operationId: repos/get-repo-ruleset-history externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 - name: ruleset_id @@ -106877,9 +107073,9 @@ paths: application/json: schema: type: array - items: *197 + items: *199 examples: - default: *443 + default: *445 '404': *6 '500': *40 x-github: @@ -106896,10 +107092,10 @@ paths: operationId: repos/get-repo-ruleset-version externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version parameters: - - *478 - - *479 + - *480 + - *481 - name: ruleset_id description: The ID of the ruleset. in: path @@ -106917,7 +107113,7 @@ paths: description: Response content: application/json: - schema: *444 + schema: *446 examples: default: value: @@ -106970,27 +107166,27 @@ paths: operationId: secret-scanning/list-alerts-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *478 - - *479 - - *445 - - *446 + - *480 + - *481 - *447 - *448 - *449 - *450 - *451 - *452 + - *453 + - *454 - *112 - *19 - *17 - - *754 - - *755 - - *453 - - *454 + - *756 + - *757 - *455 - *456 + - *457 + - *458 responses: '200': description: Response @@ -106998,7 +107194,7 @@ paths: application/json: schema: type: array - items: &759 + items: &761 type: object properties: number: *131 @@ -107017,8 +107213,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *756 - resolution: *757 + state: *758 + resolution: *759 resolved_at: type: string format: date-time @@ -107043,7 +107239,7 @@ paths: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." provider: type: string description: The provider of the secret that was detected. @@ -107124,7 +107320,7 @@ paths: pull request. ' - oneOf: *758 + oneOf: *760 nullable: true has_more_locations: type: boolean @@ -107266,7 +107462,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107286,18 +107482,18 @@ paths: operationId: secret-scanning/get-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *478 - - *479 - - *559 - - *456 + - *480 + - *481 + - *561 + - *458 responses: '200': description: Response content: application/json: - schema: *759 + schema: *761 examples: default: value: @@ -107328,7 +107524,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107349,11 +107545,11 @@ paths: - secret-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *478 - - *479 - - *559 + - *480 + - *481 + - *561 requestBody: required: true content: @@ -107361,8 +107557,8 @@ paths: schema: type: object properties: - state: *756 - resolution: *757 + state: *758 + resolution: *759 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -107373,6 +107569,14 @@ paths: to `null` to unassign the alert. type: string nullable: true + validity: + type: string + nullable: true + enum: + - active + - inactive + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -107398,7 +107602,7 @@ paths: description: Response content: application/json: - schema: *759 + schema: *761 examples: default: value: @@ -107470,8 +107674,9 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository - '503': *198 + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert + '503': *200 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -107491,11 +107696,11 @@ paths: operationId: secret-scanning/list-locations-for-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *478 - - *479 - - *559 + - *480 + - *481 + - *561 - *19 - *17 responses: @@ -107506,7 +107711,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &945 + items: &947 type: object properties: type: @@ -107532,8 +107737,6 @@ paths: example: commit details: oneOf: - - *760 - - *761 - *762 - *763 - *764 @@ -107545,6 +107748,8 @@ paths: - *770 - *771 - *772 + - *773 + - *774 examples: default: value: @@ -107608,7 +107813,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107628,10 +107833,10 @@ paths: - secret-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -107639,14 +107844,14 @@ paths: schema: type: object properties: - reason: &774 + reason: &776 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *773 + placeholder_id: *775 required: - reason - placeholder_id @@ -107663,7 +107868,7 @@ paths: schema: type: object properties: - reason: *774 + reason: *776 expire_at: type: string format: date-time @@ -107686,7 +107891,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *198 + '503': *200 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -107699,7 +107904,7 @@ paths: Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security). + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security). OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: @@ -107707,15 +107912,15 @@ paths: operationId: secret-scanning/get-scan-history externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *198 + '503': *200 '200': description: Response content: @@ -107725,7 +107930,7 @@ paths: properties: incremental_scans: type: array - items: &775 + items: &777 description: Information on a single scan performed by secret scanning on the repository type: object @@ -107751,15 +107956,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *775 + items: *777 backfill_scans: type: array - items: *775 + items: *777 custom_pattern_backfill_scans: type: array items: allOf: - - *775 + - *777 - type: object properties: pattern_name: @@ -107772,7 +107977,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *775 + items: *777 examples: default: value: @@ -107835,10 +108040,10 @@ paths: operationId: security-advisories/list-repository-advisories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *478 - - *479 + - *480 + - *481 - *112 - name: sort description: The property to sort the results by. @@ -107855,7 +108060,7 @@ paths: - *111 - name: per_page description: The number of advisories to return per page. For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -107882,9 +108087,9 @@ paths: application/json: schema: type: array - items: *776 + items: *778 examples: - default: *777 + default: *779 '400': *14 '404': *6 x-github: @@ -107905,10 +108110,10 @@ paths: operationId: security-advisories/create-repository-advisory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -107981,7 +108186,7 @@ paths: login: type: string description: The username of the user credited. - type: *461 + type: *463 required: - login - type @@ -108068,9 +108273,9 @@ paths: description: Response content: application/json: - schema: *776 + schema: *778 examples: - default: &779 + default: &781 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -108295,16 +108500,16 @@ paths: summary: Privately report a security vulnerability description: |- Report a security vulnerability to the maintainers of the repository. - See "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. + See "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. tags: - security-advisories operationId: security-advisories/create-private-vulnerability-report externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -108408,7 +108613,7 @@ paths: description: Response content: application/json: - schema: *776 + schema: *778 examples: default: value: @@ -108553,19 +108758,19 @@ paths: operationId: security-advisories/get-repository-advisory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *478 - - *479 - - *778 + - *480 + - *481 + - *780 responses: '200': description: Response content: application/json: - schema: *776 + schema: *778 examples: - default: *779 + default: *781 '403': *29 '404': *6 x-github: @@ -108587,11 +108792,11 @@ paths: operationId: security-advisories/update-repository-advisory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *478 - - *479 - - *778 + - *480 + - *481 + - *780 requestBody: required: true content: @@ -108664,7 +108869,7 @@ paths: login: type: string description: The username of the user credited. - type: *461 + type: *463 required: - login - type @@ -108750,17 +108955,17 @@ paths: description: Response content: application/json: - schema: *776 + schema: *778 examples: - default: *779 - add_credit: *779 + default: *781 + add_credit: *781 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *263 + schema: *265 examples: invalid_state_transition: value: @@ -108777,7 +108982,7 @@ paths: post: summary: Request a CVE for a repository security advisory description: |- - If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." You may request a CVE for public repositories, but cannot do so for private repositories. @@ -108789,11 +108994,11 @@ paths: operationId: security-advisories/create-repository-advisory-cve-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *478 - - *479 - - *778 + - *480 + - *481 + - *780 responses: '202': *39 '400': *14 @@ -108818,19 +109023,19 @@ paths: operationId: security-advisories/create-fork externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *478 - - *479 - - *778 + - *480 + - *481 + - *780 responses: '202': description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: *485 + default: *487 '400': *14 '422': *15 '403': *29 @@ -108846,7 +109051,7 @@ paths: description: |- Lists the people that have starred the repository. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: @@ -108854,10 +109059,10 @@ paths: operationId: activity/list-stargazers-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -108954,10 +109159,10 @@ paths: operationId: repos/get-code-frequency-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -108966,7 +109171,7 @@ paths: application/json: schema: type: array - items: &780 + items: &782 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -108997,10 +109202,10 @@ paths: operationId: repos/get-commit-activity-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -109074,10 +109279,10 @@ paths: operationId: repos/get-contributors-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -109171,10 +109376,10 @@ paths: operationId: repos/get-participation-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -109326,10 +109531,10 @@ paths: operationId: repos/get-punch-card-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -109339,7 +109544,7 @@ paths: application/json: schema: type: array - items: *780 + items: *782 examples: default: value: @@ -109370,10 +109575,10 @@ paths: operationId: repos/create-commit-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status parameters: - - *478 - - *479 + - *480 + - *481 - name: sha in: path required: true @@ -109427,7 +109632,7 @@ paths: description: Response content: application/json: - schema: *781 + schema: *783 examples: default: value: @@ -109479,10 +109684,10 @@ paths: operationId: activity/list-watchers-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -109494,7 +109699,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 x-github: @@ -109512,16 +109717,16 @@ paths: operationId: activity/get-repo-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &782 + schema: &784 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -109580,17 +109785,17 @@ paths: description: If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's - subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription) + subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription) completely. tags: - activity operationId: activity/set-repo-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: false content: @@ -109616,7 +109821,7 @@ paths: description: Response content: application/json: - schema: *782 + schema: *784 examples: default: value: @@ -109635,16 +109840,16 @@ paths: summary: Delete a repository subscription description: This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, - [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription). + [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription). tags: - activity operationId: activity/delete-repo-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -109662,10 +109867,10 @@ paths: operationId: repos/list-tags externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -109741,11 +109946,11 @@ paths: - repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *478 - - *479 + - *480 + - *481 - name: ref in: path required: true @@ -109779,10 +109984,10 @@ paths: operationId: repos/list-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams parameters: - - *478 - - *479 + - *480 + - *481 - *17 - *19 responses: @@ -109792,9 +109997,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - default: *403 + default: *405 headers: Link: *47 '404': *6 @@ -109812,10 +110017,10 @@ paths: operationId: repos/get-all-topics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics parameters: - - *478 - - *479 + - *480 + - *481 - *19 - *17 responses: @@ -109823,7 +110028,7 @@ paths: description: Response content: application/json: - schema: &783 + schema: &785 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -109835,7 +110040,7 @@ paths: required: - names examples: - default: &784 + default: &786 value: names: - octocat @@ -109856,10 +110061,10 @@ paths: operationId: repos/replace-all-topics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -109890,9 +110095,9 @@ paths: description: Response content: application/json: - schema: *783 + schema: *785 examples: - default: *784 + default: *786 '404': *6 '422': *7 x-github: @@ -109911,11 +110116,11 @@ paths: operationId: repos/get-clones externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones parameters: - - *478 - - *479 - - &785 + - *480 + - *481 + - &787 name: per description: The time frame to display results for. in: query @@ -109944,7 +110149,7 @@ paths: example: 128 clones: type: array - items: &786 + items: &788 title: Traffic type: object properties: @@ -110029,10 +110234,10 @@ paths: operationId: repos/get-top-paths externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -110120,10 +110325,10 @@ paths: operationId: repos/get-top-referrers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources parameters: - - *478 - - *479 + - *480 + - *481 responses: '200': description: Response @@ -110181,11 +110386,11 @@ paths: operationId: repos/get-views externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views parameters: - - *478 - - *479 - - *785 + - *480 + - *481 + - *787 responses: '200': description: Response @@ -110204,7 +110409,7 @@ paths: example: 3782 views: type: array - items: *786 + items: *788 required: - uniques - count @@ -110273,16 +110478,16 @@ paths: transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, - see [about repository transfers](https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/). + see [about repository transfers](https://docs.github.com/enterprise-cloud@latest/articles/about-repository-transfers/). tags: - repos operationId: repos/transfer externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository parameters: - - *478 - - *479 + - *480 + - *481 requestBody: required: true content: @@ -110318,7 +110523,7 @@ paths: description: Response content: application/json: - schema: *288 + schema: *290 examples: default: value: @@ -110548,16 +110753,16 @@ paths: summary: Check if vulnerability alerts are enabled for a repository description: Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For - more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". + more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/check-vulnerability-alerts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -110572,16 +110777,16 @@ paths: summary: Enable vulnerability alerts description: Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more - information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". + information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/enable-vulnerability-alerts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -110595,16 +110800,16 @@ paths: description: |- Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, - see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". + see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/disable-vulnerability-alerts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -110627,11 +110832,11 @@ paths: - repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *478 - - *479 + - *480 + - *481 - name: ref in: path required: true @@ -110655,7 +110860,7 @@ paths: post: summary: Create a repository using a template description: |- - Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: @@ -110663,7 +110868,7 @@ paths: operationId: repos/create-using-template externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-using-a-template + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-using-a-template parameters: - name: template_owner description: The account owner of the template repository. The name is not @@ -110723,9 +110928,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: *485 + default: *487 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -110744,13 +110949,13 @@ paths: Note: - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. tags: - repos operationId: repos/list-public externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-public-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-public-repositories parameters: - name: since description: A repository ID. Only return repositories with an ID greater @@ -110766,7 +110971,7 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: default: value: @@ -110861,7 +111066,7 @@ paths: - scim externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise parameters: - name: filter description: If specified, only results that match the specified filter will @@ -110876,7 +111081,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &794 + - &796 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -110885,7 +111090,7 @@ paths: schema: type: string example: members - - &799 + - &801 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -110896,7 +111101,7 @@ paths: default: 1 format: int32 example: 1 - - &800 + - &802 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -110938,7 +111143,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &789 + items: &791 allOf: - type: object required: @@ -111013,7 +111218,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &801 + meta: &803 type: object description: The metadata associated with the creation/updates to the user. @@ -111073,30 +111278,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &790 + '400': &792 description: Bad request content: application/json: - schema: *787 + schema: *789 application/scim+json: - schema: *787 - '401': *788 - '403': &791 + schema: *789 + '401': *790 + '403': &793 description: Permission denied - '429': &792 + '429': &794 description: Too many requests content: application/json: - schema: *787 + schema: *789 application/scim+json: - schema: *787 - '500': &793 + schema: *789 + '500': &795 description: Internal server error content: application/json: - schema: *787 + schema: *789 application/scim+json: - schema: *787 + schema: *789 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111113,14 +111318,14 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-group + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#provision-a-scim-enterprise-group parameters: - *41 requestBody: required: true content: application/json: - schema: &797 + schema: &799 type: object required: - schemas @@ -111180,9 +111385,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *789 + schema: *791 examples: - group: &795 + group: &797 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -111201,13 +111406,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *790 - '401': *788 - '403': *791 - '409': &798 + '400': *792 + '401': *790 + '403': *793 + '409': &800 description: Duplicate record detected - '429': *792 - '500': *793 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111222,9 +111427,9 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &796 + - &798 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -111232,22 +111437,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *794 + - *796 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *789 + schema: *791 examples: - default: *795 - '400': *790 - '401': *788 - '403': *791 + default: *797 + '400': *792 + '401': *790 + '403': *793 '404': *6 - '429': *792 - '500': *793 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111264,15 +111469,15 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *796 + - *798 - *41 requestBody: required: true content: application/json: - schema: *797 + schema: *799 examples: group: summary: Group @@ -111298,17 +111503,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *789 + schema: *791 examples: - group: *795 - groupWithMembers: *795 - '400': *790 - '401': *788 - '403': *791 + group: *797 + groupWithMembers: *797 + '400': *792 + '401': *790 + '403': *793 '404': *6 - '409': *798 - '429': *792 - '500': *793 + '409': *800 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111330,15 +111535,15 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *796 + - *798 - *41 requestBody: required: true content: application/json: - schema: &808 + schema: &810 type: object required: - Operations @@ -111398,17 +111603,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *789 + schema: *791 examples: - updateGroup: *795 - addMembers: *795 - '400': *790 - '401': *788 - '403': *791 + updateGroup: *797 + addMembers: *797 + '400': *792 + '401': *790 + '403': *793 '404': *6 - '409': *798 - '429': *792 - '500': *793 + '409': *800 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111422,19 +111627,19 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *796 + - *798 - *41 responses: '204': description: Group was deleted, no content - '400': *790 - '401': *788 - '403': *791 + '400': *792 + '401': *790 + '403': *793 '404': *6 - '429': *792 - '500': *793 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111452,7 +111657,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise parameters: - name: filter description: If specified, only results that match the specified filter will @@ -111468,8 +111673,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *799 - - *800 + - *801 + - *802 - *41 responses: '200': @@ -111502,7 +111707,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &803 + items: &805 allOf: - type: object required: @@ -111581,7 +111786,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &802 + roles: &804 type: array description: The roles assigned to the user. items: @@ -111637,7 +111842,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *801 + meta: *803 startIndex: type: integer description: A starting index for the returned page @@ -111674,11 +111879,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *790 - '401': *788 - '403': *791 - '429': *792 - '500': *793 + '400': *792 + '401': *790 + '403': *793 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111695,14 +111900,14 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#provision-a-scim-enterprise-user parameters: - *41 requestBody: required: true content: application/json: - schema: &806 + schema: &808 type: object required: - schemas @@ -111784,9 +111989,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *802 + roles: *804 examples: - user: &807 + user: &809 summary: User value: schemas: @@ -111833,9 +112038,9 @@ paths: description: User has been created content: application/scim+json: - schema: *803 + schema: *805 examples: - user: &804 + user: &806 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -111861,13 +112066,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *804 - '400': *790 - '401': *788 - '403': *791 - '409': *798 - '429': *792 - '500': *793 + enterpriseOwner: *806 + '400': *792 + '401': *790 + '403': *793 + '409': *800 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111882,9 +112087,9 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &805 + - &807 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -111897,15 +112102,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *803 + schema: *805 examples: - default: *804 - '400': *790 - '401': *788 - '403': *791 + default: *806 + '400': *792 + '401': *790 + '403': *793 '404': *6 - '429': *792 - '500': *793 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -111954,32 +112159,32 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *805 + - *807 - *41 requestBody: required: true content: application/json: - schema: *806 + schema: *808 examples: - user: *807 + user: *809 responses: '200': description: User was updated content: application/scim+json: - schema: *803 + schema: *805 examples: - user: *804 - '400': *790 - '401': *788 - '403': *791 + user: *806 + '400': *792 + '401': *790 + '403': *793 '404': *6 - '409': *798 - '429': *792 - '500': *793 + '409': *800 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112018,15 +112223,15 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *805 + - *807 - *41 requestBody: required: true content: application/json: - schema: *808 + schema: *810 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -112066,18 +112271,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *803 + schema: *805 examples: - userMultiValuedProperties: *804 - userSingleValuedProperties: *804 - disableUser: *804 - '400': *790 - '401': *788 - '403': *791 + userMultiValuedProperties: *806 + userSingleValuedProperties: *806 + disableUser: *806 + '400': *792 + '401': *790 + '403': *793 '404': *6 - '409': *798 - '429': *792 - '500': *793 + '409': *800 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112095,19 +112300,19 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *805 + - *807 - *41 responses: '204': description: User was deleted, no content - '400': *790 - '401': *788 - '403': *791 + '400': *792 + '401': *790 + '403': *793 '404': *6 - '429': *792 - '500': *793 + '429': *794 + '500': *795 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112138,7 +112343,7 @@ paths: operationId: scim/list-provisioned-identities externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#list-scim-provisioned-identities parameters: - *89 - name: startIndex @@ -112194,7 +112399,7 @@ paths: example: 1 Resources: type: array - items: &809 + items: &811 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -112425,22 +112630,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &810 + '404': &812 description: Resource not found content: application/json: - schema: *787 + schema: *789 application/scim+json: - schema: *787 - '403': &811 + schema: *789 + '403': &813 description: Forbidden content: application/json: - schema: *787 + schema: *789 application/scim+json: - schema: *787 - '400': *790 - '429': *792 + schema: *789 + '400': *792 + '429': *794 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -112452,13 +112657,13 @@ paths: email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see "[Reinstating a former - member of your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." + member of your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." tags: - scim operationId: scim/provision-and-invite-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#provision-and-invite-a-scim-user parameters: - *89 responses: @@ -112466,9 +112671,9 @@ paths: description: Response content: application/scim+json: - schema: *809 + schema: *811 examples: - default: &812 + default: &814 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -112491,17 +112696,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *810 - '403': *811 - '500': *793 + '404': *812 + '403': *813 + '500': *795 '409': description: Conflict content: application/json: - schema: *787 + schema: *789 application/scim+json: - schema: *787 - '400': *790 + schema: *789 + '400': *792 requestBody: required: true content: @@ -112596,20 +112801,20 @@ paths: operationId: scim/get-provisioning-information-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *89 - - *805 + - *807 responses: '200': description: Response content: application/scim+json: - schema: *809 + schema: *811 examples: - default: *812 - '404': *810 - '403': *811 + default: *814 + '404': *812 + '403': *813 '304': *37 x-github: githubCloudOnly: true @@ -112619,7 +112824,7 @@ paths: put: summary: Update a provisioned organization membership description: |- - Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead. + Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead. You must at least provide the required values for the user: `userName`, `name`, and `emails`. @@ -112630,21 +112835,21 @@ paths: operationId: scim/set-information-for-provisioned-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership parameters: - *89 - - *805 + - *807 responses: '200': description: Response content: application/scim+json: - schema: *809 + schema: *811 examples: - default: *812 + default: *814 '304': *37 - '404': *810 - '403': *811 + '404': *812 + '403': *813 requestBody: required: true content: @@ -112754,22 +112959,22 @@ paths: operationId: scim/update-attribute-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *89 - - *805 + - *807 responses: '200': description: Response content: application/scim+json: - schema: *809 + schema: *811 examples: - default: *812 + default: *814 '304': *37 - '404': *810 - '403': *811 - '400': *790 + '404': *812 + '403': *813 + '400': *792 '429': description: Response content: @@ -112857,15 +113062,15 @@ paths: operationId: scim/delete-user-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *89 - - *805 + - *807 responses: '204': description: Response - '404': *810 - '403': *811 + '404': *812 + '403': *813 '304': *37 x-github: githubCloudOnly: true @@ -112876,9 +113081,9 @@ paths: get: summary: Search code description: |- - Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). - When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: @@ -112896,7 +113101,7 @@ paths: language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. + > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: @@ -112904,15 +113109,15 @@ paths: operationId: search/code externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-code parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching code](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-code)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching code](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. in: query required: true @@ -112922,7 +113127,7 @@ paths: deprecated: true description: "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed - by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)" + by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)" in: query required: false schema: @@ -112983,7 +113188,7 @@ paths: html_url: type: string format: uri - repository: *288 + repository: *290 score: type: number file_size: @@ -113001,7 +113206,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &813 + text_matches: &815 title: Search Result Text Matches type: array items: @@ -113115,7 +113320,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *198 + '503': *200 '422': *15 '403': *29 x-github: @@ -113127,10 +113332,10 @@ paths: get: summary: Search commits description: |- - Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: @@ -113140,15 +113345,15 @@ paths: operationId: search/commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-commits parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching commits](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-commits)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching commits](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. in: query required: true @@ -113156,7 +113361,7 @@ paths: type: string - name: sort description: 'Sorts the results of your query by `author-date` or `committer-date`. - Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -113164,7 +113369,7 @@ paths: enum: - author-date - committer-date - - &814 + - &816 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -113235,7 +113440,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *529 + properties: *531 nullable: true comment_count: type: integer @@ -113255,7 +113460,7 @@ paths: url: type: string format: uri - verification: *658 + verification: *660 required: - author - committer @@ -113274,7 +113479,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *529 + properties: *531 nullable: true parents: type: array @@ -113287,12 +113492,12 @@ paths: type: string sha: type: string - repository: *288 + repository: *290 score: type: number node_id: type: string - text_matches: *813 + text_matches: *815 required: - sha - node_id @@ -113431,10 +113636,10 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. @@ -113443,21 +113648,21 @@ paths: This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." tags: - search operationId: search/issues-and-pull-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-issues-and-pull-requests + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-issues-and-pull-requests parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-issues-and-pull-requests)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. in: query required: true @@ -113468,7 +113673,7 @@ paths: `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: - [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -113485,7 +113690,7 @@ paths: - interactions - created - updated - - *814 + - *816 - *17 - *19 - name: advanced_search @@ -113599,11 +113804,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: type: string state_reason: @@ -113620,8 +113825,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *423 - required: *424 + properties: *425 + required: *426 nullable: true comments: type: integer @@ -113635,7 +113840,7 @@ paths: type: string format: date-time nullable: true - text_matches: *813 + text_matches: *815 pull_request: type: object properties: @@ -113668,7 +113873,7 @@ paths: type: string score: type: number - author_association: *224 + author_association: *226 draft: type: boolean repository: *80 @@ -113679,7 +113884,7 @@ paths: timeline_url: type: string format: uri - type: *388 + type: *390 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -113689,17 +113894,17 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 pinned_comment: title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - reactions: *225 + reactions: *227 required: - assignee - closed_at @@ -113853,7 +114058,7 @@ paths: - quoted_text items: - "..." - '503': *198 + '503': *200 '422': *15 '304': *37 '403': *29 @@ -113867,9 +114072,9 @@ paths: get: summary: Search labels description: |- - Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). - When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: @@ -113881,7 +114086,7 @@ paths: operationId: search/labels externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-labels parameters: - name: repository_id description: The id of the repository. @@ -113892,14 +114097,14 @@ paths: - name: q description: The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing - a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). + a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by when the label was `created` - or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -113907,7 +114112,7 @@ paths: enum: - created - updated - - *814 + - *816 - *17 - *19 responses: @@ -113951,7 +114156,7 @@ paths: nullable: true score: type: number - text_matches: *813 + text_matches: *815 required: - id - node_id @@ -113996,9 +114201,9 @@ paths: get: summary: Search repositories description: |- - Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). - When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: @@ -114010,15 +114215,15 @@ paths: operationId: search/repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-repositories parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest/articles/searching-for-repositories/)" for a detailed list of qualifiers. in: query required: true @@ -114027,7 +114232,7 @@ paths: - name: sort description: 'Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: - [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -114037,7 +114242,7 @@ paths: - forks - help-wanted-issues - updated - - *814 + - *816 - *17 - *19 responses: @@ -114265,8 +114470,8 @@ paths: title: License Simple description: License Simple type: object - properties: *230 - required: *231 + properties: *232 + required: *233 nullable: true permissions: type: object @@ -114285,7 +114490,7 @@ paths: - admin - pull - push - text_matches: *813 + text_matches: *815 temp_clone_token: type: string allow_merge_commit: @@ -114487,7 +114692,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *198 + '503': *200 '422': *15 '304': *37 x-github: @@ -114499,9 +114704,9 @@ paths: get: summary: Search topics description: |- - Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/)" for a detailed list of qualifiers. + Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-cloud@latest/articles/searching-topics/)" for a detailed list of qualifiers. - When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: @@ -114513,14 +114718,14 @@ paths: operationId: search/topics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-topics + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-topics parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). in: query required: true schema: @@ -114586,7 +114791,7 @@ paths: type: string format: uri nullable: true - text_matches: *813 + text_matches: *815 related: type: array nullable: true @@ -114737,9 +114942,9 @@ paths: get: summary: Search users description: |- - Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). - When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you're looking for a list of popular users, you might try this query: @@ -114747,21 +114952,21 @@ paths: This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search)." + This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest/graphql/reference/queries#search)." tags: - search operationId: search/users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-users + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-users parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching users](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-users)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching users](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. in: query required: true @@ -114770,7 +114975,7 @@ paths: - name: sort description: 'Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Cloud. Default: - [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -114779,7 +114984,7 @@ paths: - followers - repositories - joined - - *814 + - *816 - *17 - *19 responses: @@ -114883,7 +115088,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *813 + text_matches: *815 blog: type: string nullable: true @@ -114942,7 +115147,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *198 + '503': *200 '422': *15 x-github: githubCloudOnly: false @@ -114954,15 +115159,15 @@ paths: summary: Get a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-by-name) endpoint. tags: - teams operationId: teams/get-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy parameters: - - &817 + - &819 name: team_id description: The unique identifier of the team. in: path @@ -114974,9 +115179,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *472 examples: - default: *471 + default: *473 '404': *6 x-github: githubCloudOnly: false @@ -114990,7 +115195,7 @@ paths: summary: Update a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team) endpoint. To edit a team, the authenticated user must either be an organization owner or a team maintainer. @@ -115001,9 +115206,9 @@ paths: operationId: teams/update-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy parameters: - - *817 + - *819 requestBody: required: true content: @@ -115066,16 +115271,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *470 + schema: *472 examples: - default: *471 + default: *473 '201': description: Response content: application/json: - schema: *470 + schema: *472 examples: - default: *471 + default: *473 '404': *6 '422': *15 '403': *29 @@ -115091,7 +115296,7 @@ paths: summary: Delete a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team) endpoint. To delete a team, the authenticated user must be an organization owner or team maintainer. @@ -115101,9 +115306,9 @@ paths: operationId: teams/delete-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy parameters: - - *817 + - *819 responses: '204': description: Response @@ -115122,7 +115327,7 @@ paths: summary: List pending team invitations (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations) endpoint. The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. tags: @@ -115130,9 +115335,9 @@ paths: operationId: teams/list-pending-invitations-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *817 + - *819 - *17 - *19 responses: @@ -115142,9 +115347,9 @@ paths: application/json: schema: type: array - items: *382 + items: *384 examples: - default: *383 + default: *385 headers: Link: *47 x-github: @@ -115160,7 +115365,7 @@ paths: summary: List team members (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members) endpoint. Team members will include the members of child teams. tags: @@ -115168,9 +115373,9 @@ paths: operationId: teams/list-members-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy parameters: - - *817 + - *819 - name: role description: Filters members returned by their role in the team. in: query @@ -115193,7 +115398,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 '404': *6 @@ -115211,7 +115416,7 @@ paths: description: |- The "Get team member" endpoint (described below) is closing down. - We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. To list members in a team, the team must be visible to the authenticated user. tags: @@ -115219,10 +115424,10 @@ paths: operationId: teams/get-member-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy parameters: - - *817 - - *146 + - *819 + - *148 responses: '204': description: if user is a member @@ -115241,25 +115446,25 @@ paths: description: |- The "Add team member" endpoint (described below) is closing down. - We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-member-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy parameters: - - *817 - - *146 + - *819 + - *148 responses: '204': description: Response @@ -115283,23 +115488,23 @@ paths: description: |- The "Remove team member" endpoint (described below) is closing down. - We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-member-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy parameters: - - *817 - - *146 + - *819 + - *148 responses: '204': description: Response @@ -115318,7 +115523,7 @@ paths: summary: Get team membership for a user (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user) endpoint. Team members will include the members of child teams. @@ -115327,24 +115532,24 @@ paths: **Note:** The response contains the `state` of the membership and the member's `role`. - The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). + The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team). tags: - teams operationId: teams/get-membership-for-user-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *817 - - *146 + - *819 + - *148 responses: '200': description: Response content: application/json: - schema: *477 + schema: *479 examples: - response-if-user-is-a-team-maintainer: *818 + response-if-user-is-a-team-maintainer: *820 '404': *6 x-github: githubCloudOnly: false @@ -115358,14 +115563,14 @@ paths: summary: Add or update team membership for a user (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. @@ -115375,10 +115580,10 @@ paths: operationId: teams/add-or-update-membership-for-user-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *817 - - *146 + - *819 + - *148 requestBody: required: false content: @@ -115403,9 +115608,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *479 examples: - response-if-users-membership-with-team-is-now-pending: *819 + response-if-users-membership-with-team-is-now-pending: *821 '403': description: Forbidden if team synchronization is set up '422': @@ -115424,23 +115629,23 @@ paths: summary: Remove team membership for a user (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-membership-for-user-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *817 - - *146 + - *819 + - *148 responses: '204': description: Response @@ -115459,15 +115664,15 @@ paths: summary: List team repositories (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories) endpoint. tags: - teams operationId: teams/list-repos-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy parameters: - - *817 + - *819 - *17 - *19 responses: @@ -115477,9 +115682,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 '404': *6 @@ -115496,28 +115701,28 @@ paths: summary: Check team permissions for a repository (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. > [!NOTE] > Repositories inherited through a parent team will also be checked. - You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: + You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: tags: - teams operationId: teams/check-permissions-for-repo-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *817 - - *478 - - *479 + - *819 + - *480 + - *481 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *820 + schema: *822 examples: alternative-response-with-extra-repository-information: value: @@ -115656,21 +115861,21 @@ paths: summary: Add or update team repository permissions (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. - Note 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note 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 method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-or-update-repo-permissions-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *817 - - *478 - - *479 + - *819 + - *480 + - *481 requestBody: required: false content: @@ -115710,7 +115915,7 @@ paths: summary: Remove a repository from a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: @@ -115718,11 +115923,11 @@ paths: operationId: teams/remove-repo-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *817 - - *478 - - *479 + - *819 + - *480 + - *481 responses: '204': description: Response @@ -115739,9 +115944,9 @@ paths: summary: List IdP groups for a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. List IdP groups connected to a team on GitHub Enterprise Cloud. tags: @@ -115749,17 +115954,17 @@ paths: operationId: teams/list-idp-groups-for-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *817 + - *819 responses: '200': description: Response content: application/json: - schema: *480 + schema: *482 examples: - default: *481 + default: *483 '403': *29 '404': *6 x-github: @@ -115774,9 +115979,9 @@ paths: summary: Create or update IdP group connections (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. tags: @@ -115784,9 +115989,9 @@ paths: operationId: teams/create-or-update-idp-group-connections-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *817 + - *819 requestBody: required: true content: @@ -115843,7 +116048,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *482 examples: default: value: @@ -115866,15 +116071,15 @@ paths: summary: List child teams (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams) endpoint. tags: - teams operationId: teams/list-child-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy parameters: - - *817 + - *819 - *17 - *19 responses: @@ -115884,9 +116089,9 @@ paths: application/json: schema: type: array - items: *317 + items: *319 examples: - response-if-child-teams-exist: *821 + response-if-child-teams-exist: *823 headers: Link: *47 '404': *6 @@ -115910,7 +116115,7 @@ paths: operationId: users/get-authenticated externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-the-authenticated-user parameters: [] responses: '200': @@ -115919,7 +116124,7 @@ paths: application/json: schema: oneOf: - - &823 + - &825 title: Private User description: Private User type: object @@ -116122,7 +116327,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *822 + - *824 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -116224,7 +116429,7 @@ paths: operationId: users/update-authenticated externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#update-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#update-the-authenticated-user parameters: [] requestBody: required: false @@ -116275,7 +116480,7 @@ paths: description: Response content: application/json: - schema: *823 + schema: *825 examples: default: value: @@ -116341,7 +116546,7 @@ paths: operationId: users/list-blocked-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#list-users-blocked-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#list-users-blocked-by-the-authenticated-user parameters: - *17 - *19 @@ -116354,7 +116559,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 '304': *37 '404': *6 '403': *29 @@ -116375,9 +116580,9 @@ paths: operationId: users/check-blocked externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *146 + - *148 responses: '204': description: If the user is blocked @@ -116403,9 +116608,9 @@ paths: operationId: users/block externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#block-a-user parameters: - - *146 + - *148 responses: '204': description: Response @@ -116427,9 +116632,9 @@ paths: operationId: users/unblock externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#unblock-a-user parameters: - - *146 + - *148 responses: '204': description: Response @@ -116454,7 +116659,7 @@ paths: operationId: codespaces/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user parameters: - *17 - *19 @@ -116478,9 +116683,9 @@ paths: type: integer codespaces: type: array - items: *393 + items: *395 examples: - default: *394 + default: *396 '304': *37 '500': *40 '401': *25 @@ -116504,7 +116709,7 @@ paths: operationId: codespaces/create-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user requestBody: required: true content: @@ -116619,21 +116824,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '401': *25 '403': *29 '404': *6 - '503': *198 + '503': *200 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -116654,7 +116859,7 @@ paths: operationId: codespaces/list-secrets-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-secrets-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-secrets-for-the-authenticated-user parameters: - *17 - *19 @@ -116673,7 +116878,7 @@ paths: type: integer secrets: type: array - items: &824 + items: &826 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -116713,7 +116918,7 @@ paths: - visibility - selected_repositories_url examples: - default: *585 + default: *587 headers: Link: *47 x-github: @@ -116735,7 +116940,7 @@ paths: operationId: codespaces/get-public-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-public-key-for-the-authenticated-user responses: '200': description: Response @@ -116781,15 +116986,15 @@ paths: operationId: codespaces/get-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *298 + - *300 responses: '200': description: Response content: application/json: - schema: *824 + schema: *826 examples: default: value: @@ -116807,7 +117012,7 @@ paths: summary: Create or update a secret for the authenticated user description: |- Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." The authenticated user must have Codespaces access to use this endpoint. @@ -116817,9 +117022,9 @@ paths: operationId: codespaces/create-or-update-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *298 + - *300 requestBody: required: true content: @@ -116831,7 +117036,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for - the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user) + the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -116841,9 +117046,9 @@ paths: type: array description: An array of repository ids that can access the user secret. You can manage the list of selected repositories using - the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), - [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), - and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) + the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), + [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), + and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. items: anyOf: @@ -116864,7 +117069,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -116890,9 +117095,9 @@ paths: operationId: codespaces/delete-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *298 + - *300 responses: '204': description: Response @@ -116915,9 +117120,9 @@ paths: operationId: codespaces/list-repositories-for-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *298 + - *300 responses: '200': description: Response @@ -116933,9 +117138,9 @@ paths: type: integer repositories: type: array - items: *288 + items: *290 examples: - default: *332 + default: *334 '401': *25 '403': *29 '404': *6 @@ -116958,9 +117163,9 @@ paths: operationId: codespaces/set-repositories-for-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *298 + - *300 requestBody: required: true content: @@ -116972,9 +117177,9 @@ paths: type: array description: An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories - using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), - [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), - and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) + using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), + [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), + and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. items: type: integer @@ -117012,9 +117217,9 @@ paths: operationId: codespaces/add-repository-for-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *298 + - *300 - name: repository_id in: path required: true @@ -117045,9 +117250,9 @@ paths: operationId: codespaces/remove-repository-for-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *298 + - *300 - name: repository_id in: path required: true @@ -117077,17 +117282,17 @@ paths: operationId: codespaces/get-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *395 + - *397 responses: '200': description: Response content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '304': *37 '500': *40 '401': *25 @@ -117111,9 +117316,9 @@ paths: operationId: codespaces/update-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *395 + - *397 requestBody: required: false content: @@ -117143,9 +117348,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '401': *25 '403': *29 '404': *6 @@ -117165,9 +117370,9 @@ paths: operationId: codespaces/delete-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *395 + - *397 responses: '202': *39 '304': *37 @@ -117194,15 +117399,15 @@ paths: operationId: codespaces/export-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *395 + - *397 responses: '202': description: Response content: application/json: - schema: &825 + schema: &827 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -117243,7 +117448,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &826 + default: &828 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -117273,9 +117478,9 @@ paths: operationId: codespaces/get-export-details-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *395 + - *397 - name: export_id in: path required: true @@ -117288,9 +117493,9 @@ paths: description: Response content: application/json: - schema: *825 + schema: *827 examples: - default: *826 + default: *828 '404': *6 x-github: githubCloudOnly: false @@ -117309,9 +117514,9 @@ paths: operationId: codespaces/codespace-machines-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *395 + - *397 responses: '200': description: Response @@ -117327,9 +117532,9 @@ paths: type: integer machines: type: array - items: *827 + items: *829 examples: - default: *828 + default: *830 '304': *37 '500': *40 '401': *25 @@ -117356,9 +117561,9 @@ paths: operationId: codespaces/publish-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *395 + - *397 requestBody: required: true content: @@ -117408,13 +117613,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *483 + repository: *485 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *583 - required: *584 + properties: *585 + required: *586 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -118186,17 +118391,17 @@ paths: operationId: codespaces/start-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *395 + - *397 responses: '200': description: Response content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '304': *37 '500': *40 '400': *14 @@ -118226,17 +118431,17 @@ paths: operationId: codespaces/stop-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *395 + - *397 responses: '200': description: Response content: application/json: - schema: *393 + schema: *395 examples: - default: *582 + default: *584 '500': *40 '401': *25 '403': *29 @@ -118258,7 +118463,7 @@ paths: operationId: packages/list-docker-migration-conflicting-packages-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user responses: '200': description: Response @@ -118266,9 +118471,9 @@ paths: application/json: schema: type: array - items: *404 + items: *406 examples: - default: &839 + default: &841 value: - id: 197 name: hello_docker @@ -118340,7 +118545,7 @@ paths: operationId: users/set-primary-email-visibility-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user parameters: [] requestBody: required: true @@ -118369,7 +118574,7 @@ paths: application/json: schema: type: array - items: &829 + items: &831 title: Email description: Email type: object @@ -118423,7 +118628,7 @@ paths: operationId: users/list-emails-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-email-addresses-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#list-email-addresses-for-the-authenticated-user parameters: - *17 - *19 @@ -118434,9 +118639,9 @@ paths: application/json: schema: type: array - items: *829 + items: *831 examples: - default: &841 + default: &843 value: - email: octocat@github.com verified: true @@ -118462,7 +118667,7 @@ paths: operationId: users/add-email-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#add-an-email-address-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#add-an-email-address-for-the-authenticated-user parameters: [] requestBody: required: false @@ -118511,7 +118716,7 @@ paths: application/json: schema: type: array - items: *829 + items: *831 examples: default: value: @@ -118546,7 +118751,7 @@ paths: operationId: users/delete-email-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#delete-an-email-address-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#delete-an-email-address-for-the-authenticated-user parameters: [] requestBody: content: @@ -118608,7 +118813,7 @@ paths: operationId: users/list-followers-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-followers-of-the-authenticated-user parameters: - *17 - *19 @@ -118621,7 +118826,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 '304': *37 @@ -118641,7 +118846,7 @@ paths: operationId: users/list-followed-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-the-authenticated-user-follows + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-the-people-the-authenticated-user-follows parameters: - *17 - *19 @@ -118654,7 +118859,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 '304': *37 @@ -118674,9 +118879,9 @@ paths: operationId: users/check-person-is-followed-by-authenticated externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *146 + - *148 responses: '204': description: if the person is followed by the authenticated user @@ -118696,7 +118901,7 @@ paths: put: summary: Follow a user description: |- - Note that 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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that 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/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. tags: @@ -118704,9 +118909,9 @@ paths: operationId: users/follow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#follow-a-user parameters: - - *146 + - *148 responses: '204': description: Response @@ -118729,9 +118934,9 @@ paths: operationId: users/unfollow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#unfollow-a-user parameters: - - *146 + - *148 responses: '204': description: Response @@ -118756,7 +118961,7 @@ paths: operationId: users/list-gpg-keys-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user parameters: - *17 - *19 @@ -118767,7 +118972,7 @@ paths: application/json: schema: type: array - items: &830 + items: &832 title: GPG Key description: A unique encryption key type: object @@ -118898,7 +119103,7 @@ paths: - subkeys - revoked examples: - default: &857 + default: &859 value: - id: 3 name: Octocat's GPG Key @@ -118951,7 +119156,7 @@ paths: - users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user parameters: [] requestBody: required: true @@ -118983,9 +119188,9 @@ paths: description: Response content: application/json: - schema: *830 + schema: *832 examples: - default: &831 + default: &833 value: id: 3 name: Octocat's GPG Key @@ -119040,9 +119245,9 @@ paths: operationId: users/get-gpg-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &832 + - &834 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -119054,9 +119259,9 @@ paths: description: Response content: application/json: - schema: *830 + schema: *832 examples: - default: *831 + default: *833 '404': *6 '304': *37 '403': *29 @@ -119077,9 +119282,9 @@ paths: operationId: users/delete-gpg-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *832 + - *834 responses: '204': description: Response @@ -119107,7 +119312,7 @@ paths: operationId: apps/list-installations-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-app-installations-accessible-to-the-user-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token parameters: - *17 - *19 @@ -119245,7 +119450,7 @@ paths: operationId: apps/list-installation-repos-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-user-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-repositories-accessible-to-the-user-access-token parameters: - *23 - *17 @@ -119272,7 +119477,7 @@ paths: allOf: - *80 examples: - default: *283 + default: *285 headers: Link: *47 '404': *6 @@ -119295,10 +119500,10 @@ paths: operationId: apps/add-repo-to-installation-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *282 + - *284 responses: '204': description: Response @@ -119321,10 +119526,10 @@ paths: operationId: apps/remove-repo-from-installation-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *282 + - *284 responses: '204': description: Response @@ -119350,7 +119555,7 @@ paths: operationId: interactions/get-restrictions-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#get-interaction-restrictions-for-your-public-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories responses: '200': description: Default response @@ -119358,12 +119563,12 @@ paths: application/json: schema: anyOf: - - *380 + - *382 - type: object properties: {} additionalProperties: false examples: - default: *381 + default: *383 '204': description: Response when there are no restrictions x-github: @@ -119382,12 +119587,12 @@ paths: operationId: interactions/set-restrictions-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#set-interaction-restrictions-for-your-public-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories requestBody: required: true content: application/json: - schema: *668 + schema: *670 examples: default: value: @@ -119398,7 +119603,7 @@ paths: description: Response content: application/json: - schema: *380 + schema: *382 examples: default: value: @@ -119419,7 +119624,7 @@ paths: operationId: interactions/remove-restrictions-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories responses: '204': description: Response @@ -119435,9 +119640,9 @@ paths: List issues across owned and member repositories assigned to the authenticated user. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -119448,7 +119653,7 @@ paths: operationId: issues/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues @@ -119479,7 +119684,7 @@ paths: - closed - all default: open - - *391 + - *393 - name: sort description: What to sort results by. in: query @@ -119492,7 +119697,7 @@ paths: - comments default: created - *112 - - *234 + - *236 - *17 - *19 responses: @@ -119502,9 +119707,9 @@ paths: application/json: schema: type: array - items: *227 + items: *229 examples: - default: *392 + default: *394 headers: Link: *47 '404': *6 @@ -119526,7 +119731,7 @@ paths: operationId: users/list-public-ssh-keys-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-ssh-keys-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user parameters: - *17 - *19 @@ -119537,7 +119742,7 @@ paths: application/json: schema: type: array - items: &833 + items: &835 title: Key description: Key type: object @@ -119609,7 +119814,7 @@ paths: - users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user parameters: [] requestBody: required: true @@ -119638,9 +119843,9 @@ paths: description: Response content: application/json: - schema: *833 + schema: *835 examples: - default: &834 + default: &836 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -119671,17 +119876,17 @@ paths: operationId: users/get-public-ssh-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *703 + - *705 responses: '200': description: Response content: application/json: - schema: *833 + schema: *835 examples: - default: *834 + default: *836 '404': *6 '304': *37 '403': *29 @@ -119702,9 +119907,9 @@ paths: operationId: users/delete-public-ssh-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *703 + - *705 responses: '204': description: Response @@ -119726,7 +119931,7 @@ paths: operationId: apps/list-subscriptions-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user parameters: - *17 - *19 @@ -119737,7 +119942,7 @@ paths: application/json: schema: type: array - items: &835 + items: &837 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -119794,7 +119999,7 @@ paths: - id - type - login - plan: *245 + plan: *247 required: - billing_cycle - next_billing_date @@ -119805,7 +120010,7 @@ paths: - account - plan examples: - default: &836 + default: &838 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -119856,7 +120061,7 @@ paths: operationId: apps/list-subscriptions-for-authenticated-user-stubbed externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed parameters: - *17 - *19 @@ -119867,9 +120072,9 @@ paths: application/json: schema: type: array - items: *835 + items: *837 examples: - default: *836 + default: *838 headers: Link: *47 '304': *37 @@ -119888,7 +120093,7 @@ paths: operationId: orgs/list-memberships-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-memberships-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-memberships-for-the-authenticated-user parameters: - name: state description: Indicates the state of the memberships to return. If not specified, @@ -119909,7 +120114,7 @@ paths: application/json: schema: type: array - items: *396 + items: *398 examples: default: value: @@ -120015,7 +120220,7 @@ paths: operationId: orgs/get-membership-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - *89 responses: @@ -120023,7 +120228,7 @@ paths: description: Response content: application/json: - schema: *396 + schema: *398 examples: default: value: @@ -120083,7 +120288,7 @@ paths: operationId: orgs/update-membership-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - *89 requestBody: @@ -120110,7 +120315,7 @@ paths: description: Response content: application/json: - schema: *396 + schema: *398 examples: default: value: @@ -120171,7 +120376,7 @@ paths: operationId: migrations/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-user-migrations parameters: - *17 - *19 @@ -120182,7 +120387,7 @@ paths: application/json: schema: type: array - items: *398 + items: *400 examples: default: value: @@ -120352,7 +120557,7 @@ paths: operationId: migrations/start-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#start-a-user-migration parameters: [] requestBody: required: true @@ -120435,7 +120640,7 @@ paths: description: Response content: application/json: - schema: *398 + schema: *400 examples: default: value: @@ -120607,15 +120812,15 @@ paths: * `exported` - the migration finished successfully. * `failed` - the migration failed. - Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive). + Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#download-a-user-migration-archive). tags: - migrations operationId: migrations/get-status-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#get-a-user-migration-status parameters: - - *399 + - *401 - name: exclude in: query required: false @@ -120628,7 +120833,7 @@ paths: description: Response content: application/json: - schema: *398 + schema: *400 examples: default: value: @@ -120820,9 +121025,9 @@ paths: operationId: migrations/get-archive-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#download-a-user-migration-archive parameters: - - *399 + - *401 responses: '302': description: Response @@ -120838,17 +121043,17 @@ paths: summary: Delete a user migration archive description: Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned - in the [List user migrations](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations) - and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status) + in the [List user migrations](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-user-migrations) + and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. tags: - migrations operationId: migrations/delete-archive-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#delete-a-user-migration-archive parameters: - - *399 + - *401 responses: '204': description: Response @@ -120865,9 +121070,9 @@ paths: delete: summary: Unlock a user repository description: Unlocks a repository. You can lock repositories when you [start - a user migration](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration). + a user migration](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using - it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) + it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. tags: @@ -120875,10 +121080,10 @@ paths: operationId: migrations/unlock-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository parameters: - - *399 - - *837 + - *401 + - *839 responses: '204': description: Response @@ -120900,9 +121105,9 @@ paths: operationId: migrations/list-repos-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *399 + - *401 - *17 - *19 responses: @@ -120912,9 +121117,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 '404': *6 @@ -120938,7 +121143,7 @@ paths: operationId: orgs/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user parameters: - *17 - *19 @@ -120951,7 +121156,7 @@ paths: type: array items: *75 examples: - default: *258 + default: *260 headers: Link: *47 '304': *37 @@ -120968,13 +121173,13 @@ paths: description: |- Lists packages owned by the authenticated user within the user's namespace. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-the-authenticated-users-namespace + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-the-authenticated-users-namespace parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry @@ -120993,7 +121198,7 @@ paths: - docker - nuget - container - - *838 + - *840 - *19 - *17 responses: @@ -121003,10 +121208,10 @@ paths: application/json: schema: type: array - items: *404 + items: *406 examples: - default: *839 - '400': *840 + default: *841 + '400': *842 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121018,24 +121223,24 @@ paths: description: |- Gets a specific package for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *406 - - *407 + - *408 + - *409 responses: '200': description: Response content: application/json: - schema: *404 + schema: *406 examples: - default: &858 + default: &860 value: id: 40201 name: octo-name @@ -121140,16 +121345,16 @@ paths: description: |- Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *406 - - *407 + - *408 + - *409 responses: '204': description: Response @@ -121171,16 +121376,16 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *406 - - *407 + - *408 + - *409 - name: token description: package token schema: @@ -121204,16 +121409,16 @@ paths: description: |- Lists package versions for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *406 - - *407 + - *408 + - *409 - *19 - *17 - name: state @@ -121233,7 +121438,7 @@ paths: application/json: schema: type: array - items: *408 + items: *410 examples: default: value: @@ -121274,23 +121479,23 @@ paths: description: |- Gets a specific package version for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *406 - - *407 + - *408 - *409 + - *411 responses: '200': description: Response content: application/json: - schema: *408 + schema: *410 examples: default: value: @@ -121318,17 +121523,17 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *406 - - *407 + - *408 - *409 + - *411 responses: '204': description: Response @@ -121350,17 +121555,17 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *406 - - *407 + - *408 - *409 + - *411 responses: '204': description: Response @@ -121377,7 +121582,7 @@ paths: summary: List public email addresses for the authenticated user description: |- Lists your publicly visible email address, which you can set with the - [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. @@ -121386,7 +121591,7 @@ paths: operationId: users/list-public-emails-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-public-email-addresses-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#list-public-email-addresses-for-the-authenticated-user parameters: - *17 - *19 @@ -121397,9 +121602,9 @@ paths: application/json: schema: type: array - items: *829 + items: *831 examples: - default: *841 + default: *843 headers: Link: *47 '304': *37 @@ -121423,7 +121628,7 @@ paths: operationId: repos/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repositories-for-the-authenticated-user parameters: - name: visibility description: Limit results to repositories with the specified visibility. @@ -121512,7 +121717,7 @@ paths: type: array items: *80 examples: - default: &848 + default: &850 summary: Default response value: - id: 1296269 @@ -121654,7 +121859,7 @@ paths: operationId: repos/create-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user parameters: [] requestBody: required: true @@ -121816,9 +122021,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: *485 + default: *487 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -121845,7 +122050,7 @@ paths: operationId: repos/list-invitations-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user parameters: - *17 - *19 @@ -121856,9 +122061,9 @@ paths: application/json: schema: type: array - items: *670 + items: *672 examples: - default: *842 + default: *844 headers: Link: *47 '304': *37 @@ -121879,9 +122084,9 @@ paths: operationId: repos/accept-invitation-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *384 + - *386 responses: '204': description: Response @@ -121902,9 +122107,9 @@ paths: operationId: repos/decline-invitation-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *384 + - *386 responses: '204': description: Response @@ -121926,7 +122131,7 @@ paths: operationId: users/list-social-accounts-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user parameters: - *17 - *19 @@ -121937,7 +122142,7 @@ paths: application/json: schema: type: array - items: &843 + items: &845 title: Social account description: Social media account type: object @@ -121952,7 +122157,7 @@ paths: - provider - url examples: - default: &844 + default: &846 value: - provider: twitter url: https://twitter.com/github @@ -121978,7 +122183,7 @@ paths: operationId: users/add-social-account-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#add-social-accounts-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user parameters: [] requestBody: required: true @@ -122014,9 +122219,9 @@ paths: application/json: schema: type: array - items: *843 + items: *845 examples: - default: *844 + default: *846 '422': *15 '304': *37 '404': *6 @@ -122038,7 +122243,7 @@ paths: operationId: users/delete-social-account-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user parameters: [] requestBody: required: true @@ -122092,7 +122297,7 @@ paths: operationId: users/list-ssh-signing-keys-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user parameters: - *17 - *19 @@ -122103,7 +122308,7 @@ paths: application/json: schema: type: array - items: &845 + items: &847 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -122123,7 +122328,7 @@ paths: - title - created_at examples: - default: &872 + default: &874 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -122156,7 +122361,7 @@ paths: - users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user parameters: [] requestBody: required: true @@ -122170,7 +122375,7 @@ paths: example: Personal MacBook Air key: description: The public SSH key to add to your GitHub account. For - more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest//authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." type: string pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " @@ -122187,9 +122392,9 @@ paths: description: Response content: application/json: - schema: *845 + schema: *847 examples: - default: &846 + default: &848 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -122217,9 +122422,9 @@ paths: operationId: users/get-ssh-signing-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &847 + - &849 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -122231,9 +122436,9 @@ paths: description: Response content: application/json: - schema: *845 + schema: *847 examples: - default: *846 + default: *848 '404': *6 '304': *37 '403': *29 @@ -122254,9 +122459,9 @@ paths: operationId: users/delete-ssh-signing-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *847 + - *849 responses: '204': description: Response @@ -122275,7 +122480,7 @@ paths: description: |- Lists repositories the authenticated user has starred. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: @@ -122283,9 +122488,9 @@ paths: operationId: activity/list-repos-starred-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &873 + - &875 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -122310,11 +122515,11 @@ paths: type: array items: *80 examples: - default-response: *848 + default-response: *850 application/vnd.github.v3.star+json: schema: type: array - items: &874 + items: &876 title: Starred Repository description: Starred Repository type: object @@ -122468,10 +122673,10 @@ paths: operationId: activity/check-repo-is-starred-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response if this repository is starred by you @@ -122491,16 +122696,16 @@ paths: put: summary: Star a repository for the authenticated user description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - activity operationId: activity/star-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -122522,10 +122727,10 @@ paths: operationId: activity/unstar-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *478 - - *479 + - *480 + - *481 responses: '204': description: Response @@ -122547,7 +122752,7 @@ paths: operationId: activity/list-watched-repos-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-repositories-watched-by-the-authenticated-user parameters: - *17 - *19 @@ -122558,9 +122763,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 '304': *37 @@ -122586,7 +122791,7 @@ paths: operationId: teams/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-teams-for-the-authenticated-user parameters: - *17 - *19 @@ -122597,7 +122802,7 @@ paths: application/json: schema: type: array - items: *470 + items: *472 examples: default: value: @@ -122663,19 +122868,19 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. - If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. - The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#authentication). - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails). + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest/rest/users/emails). tags: - users operationId: users/get-by-id externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-a-user-using-their-id parameters: - - *247 + - *249 responses: '200': description: Response @@ -122683,10 +122888,10 @@ paths: application/json: schema: oneOf: - - *823 - - *822 + - *825 + - *824 examples: - default-response: &852 + default-response: &854 summary: Default response value: login: octocat @@ -122721,7 +122926,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &853 + response-with-git-hub-plan-information: &855 summary: Response with GitHub plan information value: login: octocat @@ -122776,16 +122981,16 @@ paths: operationId: projects/create-draft-item-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &850 + - &852 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *422 + - *424 requestBody: required: true description: Details of the draft item to create in the project. @@ -122819,9 +123024,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *430 examples: - draft_issue: *429 + draft_issue: *431 '304': *37 '403': *29 '401': *25 @@ -122836,15 +123041,15 @@ paths: description: |- Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts. - Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. tags: - users operationId: users/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users parameters: - - *849 + - *851 - *17 responses: '200': @@ -122855,7 +123060,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: example: ; rel="next" @@ -122877,10 +123082,10 @@ paths: operationId: projects/create-view-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-a-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *850 - - *422 + - *852 + - *424 requestBody: required: true content: @@ -122902,7 +123107,7 @@ paths: example: board filter: type: string - description: The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + description: The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. example: is:issue is:open visible_fields: @@ -122951,17 +123156,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *851 + schema: *853 examples: table_view: summary: Response for creating a table view - value: *433 + value: *435 board_view: summary: Response for creating a board view with filter - value: *433 + value: *435 roadmap_view: summary: Response for creating a roadmap view - value: *433 + value: *435 '304': *37 '403': *29 '401': *25 @@ -122983,19 +123188,19 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. - If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. - The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#authentication). - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails). + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest/rest/users/emails). tags: - users operationId: users/get-by-username externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-a-user parameters: - - *146 + - *148 responses: '200': description: Response @@ -123003,11 +123208,11 @@ paths: application/json: schema: oneOf: - - *823 - - *822 + - *825 + - *824 examples: - default-response: *852 - response-with-git-hub-plan-information: *853 + default-response: *854 + response-with-git-hub-plan-information: *855 '404': *6 x-github: githubCloudOnly: false @@ -123022,18 +123227,18 @@ paths: The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - users operationId: users/list-attestations-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - *110 - *111 - - *146 + - *148 requestBody: required: true content: @@ -123057,8 +123262,8 @@ paths: required: - subject_digests examples: - default: *854 - withPredicateType: *855 + default: *856 + withPredicateType: *857 responses: '200': description: Response @@ -123111,7 +123316,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *856 + default: *858 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -123127,9 +123332,9 @@ paths: operationId: users/delete-attestations-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-in-bulk parameters: - - *146 + - *148 requestBody: required: true content: @@ -123192,9 +123397,9 @@ paths: operationId: users/delete-attestations-by-subject-digest externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *146 + - *148 - name: subject_digest description: Subject Digest in: path @@ -123223,9 +123428,9 @@ paths: operationId: users/delete-attestations-by-id externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-by-id parameters: - - *146 + - *148 - name: attestation_id description: Attestation ID in: path @@ -123252,18 +123457,18 @@ paths: The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - users operationId: users/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#list-attestations parameters: - *17 - *110 - *111 - - *146 + - *148 - name: subject_digest description: Subject Digest in: path @@ -123316,12 +123521,12 @@ paths: initiator: type: string examples: - default: *525 + default: *527 '201': description: Response content: application/json: - schema: *299 + schema: *301 examples: default: value: @@ -123345,9 +123550,9 @@ paths: operationId: packages/list-docker-migration-conflicting-packages-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *146 + - *148 responses: '200': description: Response @@ -123355,9 +123560,9 @@ paths: application/json: schema: type: array - items: *404 + items: *406 examples: - default: *839 + default: *841 '403': *29 '401': *25 x-github: @@ -123378,9 +123583,9 @@ paths: operationId: activity/list-events-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -123390,7 +123595,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: default: value: @@ -123450,9 +123655,9 @@ paths: operationId: activity/list-org-events-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *146 + - *148 - *89 - *17 - *19 @@ -123463,7 +123668,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: default: value: @@ -123538,9 +123743,9 @@ paths: operationId: activity/list-public-events-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -123550,7 +123755,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: default: value: @@ -123606,9 +123811,9 @@ paths: operationId: users/list-followers-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-followers-of-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -123620,7 +123825,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 x-github: @@ -123637,9 +123842,9 @@ paths: operationId: users/list-following-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-the-people-a-user-follows parameters: - - *146 + - *148 - *17 - *19 responses: @@ -123651,7 +123856,7 @@ paths: type: array items: *4 examples: - default: *216 + default: *218 headers: Link: *47 x-github: @@ -123668,9 +123873,9 @@ paths: operationId: users/check-following-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *146 + - *148 - name: target_user in: path required: true @@ -123695,10 +123900,10 @@ paths: operationId: gists/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gists-for-a-user parameters: - - *146 - - *234 + - *148 + - *236 - *17 - *19 responses: @@ -123708,9 +123913,9 @@ paths: application/json: schema: type: array - items: *235 + items: *237 examples: - default: *236 + default: *238 headers: Link: *47 '422': *15 @@ -123729,9 +123934,9 @@ paths: operationId: users/list-gpg-keys-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -123741,9 +123946,9 @@ paths: application/json: schema: type: array - items: *830 + items: *832 examples: - default: *857 + default: *859 headers: Link: *47 x-github: @@ -123765,9 +123970,9 @@ paths: operationId: users/get-context-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-contextual-information-for-a-user parameters: - - *146 + - *148 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -123831,15 +124036,15 @@ paths: description: |- Enables an authenticated GitHub App to find the user’s installation information. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-user-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *146 + - *148 responses: '200': description: Response @@ -123847,7 +124052,7 @@ paths: application/json: schema: *22 examples: - default: *378 + default: *380 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123863,9 +124068,9 @@ paths: operationId: users/list-public-keys-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#list-public-keys-for-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -123910,17 +124115,17 @@ paths: get: summary: List organizations for a user description: |- - List [public organization memberships](https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership) for the specified user. + List [public organization memberships](https://docs.github.com/enterprise-cloud@latest/articles/publicizing-or-concealing-organization-membership) for the specified user. - This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. tags: - orgs operationId: orgs/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -123932,7 +124137,7 @@ paths: type: array items: *75 examples: - default: *258 + default: *260 headers: Link: *47 x-github: @@ -123946,13 +124151,13 @@ paths: description: |- Lists all packages in a user's namespace for which the requesting user has access. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-a-user parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry @@ -123971,8 +124176,8 @@ paths: - docker - nuget - container - - *838 - - *146 + - *840 + - *148 - *19 - *17 responses: @@ -123982,12 +124187,12 @@ paths: application/json: schema: type: array - items: *404 + items: *406 examples: - default: *839 + default: *841 '403': *29 '401': *25 - '400': *840 + '400': *842 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123999,25 +124204,25 @@ paths: description: |- Gets a specific package metadata for a public package owned by a user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-a-user parameters: - - *406 - - *407 - - *146 + - *408 + - *409 + - *148 responses: '200': description: Response content: application/json: - schema: *404 + schema: *406 examples: - default: *858 + default: *860 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -124028,19 +124233,19 @@ paths: description: |- Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-a-user parameters: - - *406 - - *407 - - *146 + - *408 + - *409 + - *148 responses: '204': description: Response @@ -124062,19 +124267,19 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-a-user parameters: - - *406 - - *407 - - *146 + - *408 + - *409 + - *148 - name: token description: package token schema: @@ -124098,17 +124303,17 @@ paths: description: |- Lists package versions for a public package owned by a specified user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *406 - - *407 - - *146 + - *408 + - *409 + - *148 responses: '200': description: Response @@ -124116,7 +124321,7 @@ paths: application/json: schema: type: array - items: *408 + items: *410 examples: default: value: @@ -124166,24 +124371,24 @@ paths: description: |- Gets a specific package version for a public package owned by a specified user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *406 - - *407 + - *408 - *409 - - *146 + - *411 + - *148 responses: '200': description: Response content: application/json: - schema: *408 + schema: *410 examples: default: value: @@ -124208,20 +124413,20 @@ paths: description: |- Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-package-version-for-a-user parameters: - - *406 - - *407 - - *146 + - *408 - *409 + - *148 + - *411 responses: '204': description: Response @@ -124243,20 +124448,20 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, 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)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-package-version-for-a-user parameters: - - *406 - - *407 - - *146 + - *408 - *409 + - *148 + - *411 responses: '204': description: Response @@ -124278,9 +124483,9 @@ paths: operationId: projects/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#list-projects-for-user parameters: - - *146 + - *148 - name: q description: Limit results to projects of the specified type. in: query @@ -124297,9 +124502,9 @@ paths: application/json: schema: type: array - items: *420 + items: *422 examples: - default: *421 + default: *423 headers: Link: *47 '304': *37 @@ -124319,18 +124524,18 @@ paths: operationId: projects/get-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#get-project-for-user parameters: - - *422 - - *146 + - *424 + - *148 responses: '200': description: Response content: application/json: - schema: *420 + schema: *422 examples: - default: *421 + default: *423 headers: Link: *47 '304': *37 @@ -124350,10 +124555,10 @@ paths: operationId: projects/list-fields-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#list-project-fields-for-user parameters: - - *422 - - *146 + - *424 + - *148 - *17 - *110 - *111 @@ -124364,9 +124569,9 @@ paths: application/json: schema: type: array - items: *426 + items: *428 examples: - default: *859 + default: *861 headers: Link: *47 '304': *37 @@ -124385,10 +124590,10 @@ paths: operationId: projects/add-field-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#add-field-to-user-owned-project parameters: - - *146 - - *422 + - *148 + - *424 requestBody: required: true content: @@ -124426,7 +124631,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *860 + items: *862 required: - name - data_type @@ -124442,7 +124647,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *861 + iteration_configuration: *863 required: - name - data_type @@ -124464,20 +124669,20 @@ paths: value: name: Due date data_type: date - single_select_field: *862 - iteration_field: *863 + single_select_field: *864 + iteration_field: *865 responses: '201': description: Response content: application/json: - schema: *426 + schema: *428 examples: - text_field: *864 - number_field: *865 - date_field: *866 - single_select_field: *867 - iteration_field: *868 + text_field: *866 + number_field: *867 + date_field: *868 + single_select_field: *869 + iteration_field: *870 '304': *37 '403': *29 '401': *25 @@ -124496,19 +124701,19 @@ paths: operationId: projects/get-field-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user parameters: - - *422 - - *869 - - *146 + - *424 + - *871 + - *148 responses: '200': description: Response content: application/json: - schema: *426 + schema: *428 examples: - default: *870 + default: *872 headers: Link: *47 '304': *37 @@ -124529,15 +124734,15 @@ paths: operationId: projects/list-items-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *422 - - *146 + - *424 + - *148 - *110 - *111 - *17 - name: q - description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. in: query required: false @@ -124564,9 +124769,9 @@ paths: application/json: schema: type: array - items: *430 + items: *432 examples: - default: *431 + default: *433 headers: Link: *47 '304': *37 @@ -124585,10 +124790,10 @@ paths: operationId: projects/add-item-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#add-item-to-user-owned-project parameters: - - *146 - - *422 + - *148 + - *424 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -124658,22 +124863,22 @@ paths: description: Response content: application/json: - schema: *428 + schema: *430 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *429 + value: *431 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *429 + value: *431 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *429 + value: *431 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *429 + value: *431 '304': *37 '403': *29 '401': *25 @@ -124691,11 +124896,11 @@ paths: operationId: projects/get-user-item externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *422 - - *146 - - *432 + - *424 + - *148 + - *434 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -124715,9 +124920,9 @@ paths: description: Response content: application/json: - schema: *430 + schema: *432 examples: - default: *431 + default: *433 headers: Link: *47 '304': *37 @@ -124736,11 +124941,11 @@ paths: operationId: projects/update-item-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#update-project-item-for-user parameters: - - *422 - - *146 - - *432 + - *424 + - *148 + - *434 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -124810,13 +125015,13 @@ paths: description: Response content: application/json: - schema: *430 + schema: *432 examples: - text_field: *431 - number_field: *431 - date_field: *431 - single_select_field: *431 - iteration_field: *431 + text_field: *433 + number_field: *433 + date_field: *433 + single_select_field: *433 + iteration_field: *433 '401': *25 '403': *29 '404': *6 @@ -124834,11 +125039,11 @@ paths: operationId: projects/delete-item-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#delete-project-item-for-user parameters: - - *422 - - *146 - - *432 + - *424 + - *148 + - *434 responses: '204': description: Response @@ -124858,11 +125063,11 @@ paths: operationId: projects/list-view-items-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-project-view + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-a-user-project-view parameters: - - *422 - - *146 - - *871 + - *424 + - *148 + - *873 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -124888,9 +125093,9 @@ paths: application/json: schema: type: array - items: *430 + items: *432 examples: - default: *431 + default: *433 headers: Link: *47 '304': *37 @@ -124916,9 +125121,9 @@ paths: operationId: activity/list-received-events-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -124928,7 +125133,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: default: value: @@ -124991,9 +125196,9 @@ paths: operationId: activity/list-received-public-events-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-received-by-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -125003,7 +125208,7 @@ paths: application/json: schema: type: array - items: *253 + items: *255 examples: default: value: @@ -125064,9 +125269,9 @@ paths: operationId: repos/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repositories-for-a-user parameters: - - *146 + - *148 - name: type description: Limit results to repositories of the specified type. in: query @@ -125109,9 +125314,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 x-github: @@ -125129,9 +125334,9 @@ paths: operationId: users/list-social-accounts-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -125141,9 +125346,9 @@ paths: application/json: schema: type: array - items: *843 + items: *845 examples: - default: *844 + default: *846 headers: Link: *47 x-github: @@ -125161,9 +125366,9 @@ paths: operationId: users/list-ssh-signing-keys-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -125173,9 +125378,9 @@ paths: application/json: schema: type: array - items: *845 + items: *847 examples: - default: *872 + default: *874 headers: Link: *47 x-github: @@ -125189,7 +125394,7 @@ paths: description: |- Lists repositories a user has starred. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: @@ -125197,10 +125402,10 @@ paths: operationId: activity/list-repos-starred-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *146 - - *873 + - *148 + - *875 - *112 - *17 - *19 @@ -125212,11 +125417,11 @@ paths: schema: anyOf: - type: array - items: *874 + items: *876 - type: array items: *80 examples: - default-response: *848 + default-response: *850 headers: Link: *47 x-github: @@ -125233,9 +125438,9 @@ paths: operationId: activity/list-repos-watched-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *146 + - *148 - *17 - *19 responses: @@ -125245,9 +125450,9 @@ paths: application/json: schema: type: array - items: *288 + items: *290 examples: - default: *410 + default: *412 headers: Link: *47 x-github: @@ -125264,7 +125469,7 @@ paths: operationId: meta/get-all-versions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-all-api-versions + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-all-api-versions responses: '200': description: Response @@ -125297,7 +125502,7 @@ paths: operationId: meta/get-zen externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-the-zen-of-github + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-the-zen-of-github responses: '200': description: Response @@ -125319,14 +125524,14 @@ x-webhooks: post: summary: |- This event occurs when there is a change to branch protection configurations for a repository. - For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." - For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." + For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: All branch protections were disabled for a repository. operationId: branch-protection-configuration/disabled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration parameters: - name: User-Agent in: header @@ -125375,12 +125580,12 @@ x-webhooks: type: string enum: - disabled - enterprise: &875 + enterprise: &877 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, - see "[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts)." + see "[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)." type: object properties: description: @@ -125433,12 +125638,12 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &876 + installation: &878 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, - see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." type: object properties: id: @@ -125452,7 +125657,7 @@ x-webhooks: required: - id - node_id - organization: &877 + organization: &879 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -125512,13 +125717,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &878 + repository: &880 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &917 + properties: &919 id: description: Unique identifier of the repository example: 42 @@ -125538,8 +125743,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *230 - required: *231 + properties: *232 + required: *233 nullable: true organization: title: Simple User @@ -126213,7 +126418,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &918 + required: &920 - archive_url - assignees_url - blobs_url @@ -126308,14 +126513,14 @@ x-webhooks: post: summary: |- This event occurs when there is a change to branch protection configurations for a repository. - For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." - For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." + For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: All branch protections were enabled for a repository. operationId: branch-protection-configuration/enabled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration parameters: - name: User-Agent in: header @@ -126364,10 +126569,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -126388,13 +126593,13 @@ x-webhooks: branch-protection-rule-created: post: summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was created. operationId: branch-protection-rule/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header @@ -126443,14 +126648,14 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - rule: &879 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + rule: &881 title: branch protection rule description: The branch protection rule. Includes a `name` and all - the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -126615,13 +126820,13 @@ x-webhooks: branch-protection-rule-deleted: post: summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was deleted. operationId: branch-protection-rule/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header @@ -126670,11 +126875,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - rule: *879 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + rule: *881 sender: *4 required: - action @@ -126696,13 +126901,13 @@ x-webhooks: branch-protection-rule-edited: post: summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was edited. operationId: branch-protection-rule/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header @@ -126857,11 +127062,11 @@ x-webhooks: - everyone required: - from - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - rule: *879 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + rule: *881 sender: *4 required: - action @@ -126885,7 +127090,7 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -126893,7 +127098,7 @@ x-webhooks: description: A secret scanning push protection bypass request was cancelled. operationId: exemption-request-secret-scanning/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -126934,7 +127139,7 @@ x-webhooks: required: true content: application/json: - schema: &901 + schema: &903 title: Exemption request cancellation event type: object properties: @@ -126942,11 +127147,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - exemption_request: &880 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + exemption_request: &882 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -127250,7 +127455,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &881 + items: &883 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -127311,7 +127516,7 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -127319,7 +127524,7 @@ x-webhooks: description: A secret scanning bypass request was completed. operationId: exemption-request-secret-scanning/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -127360,7 +127565,7 @@ x-webhooks: required: true content: application/json: - schema: &902 + schema: &904 title: Exemption request completed event type: object properties: @@ -127368,11 +127573,11 @@ x-webhooks: type: string enum: - completed - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - exemption_request: *880 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + exemption_request: *882 sender: *4 required: - action @@ -127395,7 +127600,7 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -127403,7 +127608,7 @@ x-webhooks: description: A secret scanning push protection bypass request was created. operationId: exemption-request-secret-scanning/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -127444,7 +127649,7 @@ x-webhooks: required: true content: application/json: - schema: &899 + schema: &901 title: Exemption request created event type: object properties: @@ -127452,11 +127657,11 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - exemption_request: *880 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + exemption_request: *882 sender: *4 required: - action @@ -127479,7 +127684,7 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -127487,7 +127692,7 @@ x-webhooks: description: A secret scanning push protection bypass response was dismissed. operationId: exemption-request-secret-scanning/response-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -127528,7 +127733,7 @@ x-webhooks: required: true content: application/json: - schema: &903 + schema: &905 title: Exemption response dismissed event type: object properties: @@ -127536,12 +127741,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - exemption_request: *880 - exemption_response: *881 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + exemption_request: *882 + exemption_response: *883 sender: *4 required: - action @@ -127565,7 +127770,7 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -127574,7 +127779,7 @@ x-webhooks: protection bypass request was submitted. operationId: exemption-request-secret-scanning/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -127615,7 +127820,7 @@ x-webhooks: required: true content: application/json: - schema: &900 + schema: &902 title: Exemption response submitted event type: object properties: @@ -127623,12 +127828,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - exemption_request: *880 - exemption_response: *881 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + exemption_request: *882 + exemption_response: *883 sender: *4 required: - action @@ -127650,7 +127855,7 @@ x-webhooks: check-run-completed: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. @@ -127663,7 +127868,7 @@ x-webhooks: description: A check run was completed, and a conclusion is available. operationId: check-run/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header @@ -127712,7 +127917,7 @@ x-webhooks: type: string enum: - completed - check_run: &883 + check_run: &885 title: CheckRun description: A check performed on the code of a given code change type: object @@ -127765,8 +127970,8 @@ x-webhooks: type: string pull_requests: type: array - items: *232 - repository: *288 + items: *234 + repository: *290 status: example: completed type: string @@ -127803,7 +128008,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *882 + deployment: *884 details_url: example: https://example.com type: string @@ -127853,7 +128058,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *232 + items: *234 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -127888,10 +128093,10 @@ x-webhooks: - output - app - pull_requests - installation: *876 - enterprise: *875 - organization: *877 - repository: *878 + installation: *878 + enterprise: *877 + organization: *879 + repository: *880 sender: *4 required: - check_run @@ -128220,7 +128425,7 @@ x-webhooks: check-run-created: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. @@ -128233,7 +128438,7 @@ x-webhooks: description: A new check run was created. operationId: check-run/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header @@ -128282,11 +128487,11 @@ x-webhooks: type: string enum: - created - check_run: *883 - installation: *876 - enterprise: *875 - organization: *877 - repository: *878 + check_run: *885 + installation: *878 + enterprise: *877 + organization: *879 + repository: *880 sender: *4 required: - check_run @@ -128615,7 +128820,7 @@ x-webhooks: check-run-requested-action: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. @@ -128628,10 +128833,10 @@ x-webhooks: description: A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, - see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api)." + see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest/developers/apps/guides/creating-ci-tests-with-the-checks-api)." operationId: check-run/requested-action externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header @@ -128680,11 +128885,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *883 - installation: *876 - enterprise: *875 - organization: *877 - repository: *878 + check_run: *885 + installation: *878 + enterprise: *877 + organization: *879 + repository: *880 requested_action: description: The action requested by the user. type: object @@ -129024,7 +129229,7 @@ x-webhooks: check-run-rerequested: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. @@ -129038,7 +129243,7 @@ x-webhooks: someone requests to re-run the check will receive the `rerequested` payload. operationId: check-run/rerequested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header @@ -129087,11 +129292,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *883 - installation: *876 - enterprise: *875 - organization: *877 - repository: *878 + check_run: *885 + installation: *878 + enterprise: *877 + organization: *879 + repository: *880 sender: *4 required: - check_run @@ -129420,7 +129625,7 @@ x-webhooks: check-suite-completed: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. @@ -129434,7 +129639,7 @@ x-webhooks: is available. operationId: check-suite/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -129484,7 +129689,7 @@ x-webhooks: enum: - completed check_suite: - description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). + description: The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -130061,10 +130266,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -130086,7 +130291,7 @@ x-webhooks: check-suite-requested: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. @@ -130098,12 +130303,12 @@ x-webhooks: > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, - see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) - or "[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)" + see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest/graphql/reference/mutations#createcheckrun) + or "[Create a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run)" in the REST API documentation. operationId: check-suite/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -130153,7 +130358,7 @@ x-webhooks: enum: - requested check_suite: - description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). + description: The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -130753,10 +130958,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -130778,7 +130983,7 @@ x-webhooks: check-suite-rerequested: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. @@ -130790,12 +130995,12 @@ x-webhooks: > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check - suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) - or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)" + suite](https://docs.github.com/enterprise-cloud@latest/graphql/reference/mutations#createchecksuite) + or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite)" in the REST API documentation. operationId: check-suite/rerequested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -130845,7 +131050,7 @@ x-webhooks: enum: - rerequested check_suite: - description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). + description: The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -131439,10 +131644,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -131464,7 +131669,7 @@ x-webhooks: code-scanning-alert-appeared-in-branch: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A previously created code scanning alert appeared in another branch. @@ -131472,7 +131677,7 @@ x-webhooks: a pre-existing code scanning alert. operationId: code-scanning-alert/appeared-in-branch externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -131608,7 +131813,7 @@ x-webhooks: required: - login - id - dismissed_comment: *554 + dismissed_comment: *556 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -131753,20 +131958,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &884 + commit_oid: &886 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *875 - installation: *876 - organization: *877 - ref: &885 + enterprise: *877 + installation: *878 + organization: *879 + ref: &887 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *878 + repository: *880 sender: *4 required: - action @@ -131790,13 +131995,13 @@ x-webhooks: code-scanning-alert-closed-by-user: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: Someone closed a code scanning alert. operationId: code-scanning-alert/closed-by-user externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -131931,7 +132136,7 @@ x-webhooks: required: - login - id - dismissed_comment: *554 + dismissed_comment: *556 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -132161,12 +132366,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *884 - enterprise: *875 - installation: *876 - organization: *877 - ref: *885 - repository: *878 + commit_oid: *886 + enterprise: *877 + installation: *878 + organization: *879 + ref: *887 + repository: *880 sender: *4 required: - action @@ -132190,13 +132395,13 @@ x-webhooks: code-scanning-alert-created: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A code scanning alert was created in a repository. operationId: code-scanning-alert/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -132261,7 +132466,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *554 + dismissed_comment: *556 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132432,12 +132637,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *884 - enterprise: *875 - installation: *876 - organization: *877 - ref: *885 - repository: *878 + commit_oid: *886 + enterprise: *877 + installation: *878 + organization: *879 + ref: *887 + repository: *880 sender: *4 required: - action @@ -132461,13 +132666,13 @@ x-webhooks: code-scanning-alert-fixed: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A code scanning alert was fixed in a branch by a commit. operationId: code-scanning-alert/fixed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -132603,7 +132808,7 @@ x-webhooks: required: - login - id - dismissed_comment: *554 + dismissed_comment: *556 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -132769,12 +132974,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *884 - enterprise: *875 - installation: *876 - organization: *877 - ref: *885 - repository: *878 + commit_oid: *886 + enterprise: *877 + installation: *878 + organization: *879 + ref: *887 + repository: *880 sender: *4 required: - action @@ -132798,13 +133003,13 @@ x-webhooks: code-scanning-alert-reopened: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A previously fixed code scanning alert reappeared in a branch. operationId: code-scanning-alert/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -132873,7 +133078,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *554 + dismissed_comment: *556 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -133048,16 +133253,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *878 + repository: *880 sender: *4 required: - action @@ -133081,13 +133286,13 @@ x-webhooks: code-scanning-alert-reopened-by-user: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: Someone reopened a code scanning alert. operationId: code-scanning-alert/reopened-by-user externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -133154,7 +133359,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *554 + dismissed_comment: *556 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -133294,12 +133499,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *884 - enterprise: *875 - installation: *876 - organization: *877 - ref: *885 - repository: *878 + commit_oid: *886 + enterprise: *877 + installation: *878 + organization: *879 + ref: *887 + repository: *880 sender: *4 required: - action @@ -133323,13 +133528,13 @@ x-webhooks: code-scanning-alert-updated-assignment: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: The assignees list of a code scanning alert has been updated. operationId: code-scanning-alert/updated-assignment externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -133465,7 +133670,7 @@ x-webhooks: required: - login - id - dismissed_comment: *554 + dismissed_comment: *556 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -133610,10 +133815,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -133635,7 +133840,7 @@ x-webhooks: commit-comment-created: post: summary: |- - This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)" in the REST API documentation. + This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments)" in the REST API documentation. For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. @@ -133643,7 +133848,7 @@ x-webhooks: description: Someone commented on a commit. operationId: commit-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#commit_comment parameters: - name: User-Agent in: header @@ -133868,10 +134073,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -133902,7 +134107,7 @@ x-webhooks: - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. operationId: create externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#create parameters: - name: User-Agent in: header @@ -133951,19 +134156,19 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *877 - pusher_type: &886 + organization: *879 + pusher_type: &888 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &887 - description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) + ref: &889 + description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource. type: string ref_type: @@ -133972,7 +134177,7 @@ x-webhooks: enum: - tag - branch - repository: *878 + repository: *880 sender: *4 required: - ref @@ -133999,13 +134204,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A new custom property was created. operationId: custom-property/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -134054,10 +134259,10 @@ x-webhooks: type: string enum: - created - definition: *159 - enterprise: *875 - installation: *876 - organization: *877 + definition: *161 + enterprise: *877 + installation: *878 + organization: *879 sender: *4 required: - action @@ -134079,13 +134284,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was deleted. operationId: custom-property/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -134142,9 +134347,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 sender: *4 required: - action @@ -134166,13 +134371,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was promoted to an enterprise. operationId: custom-property/promote-to-enterprise externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -134221,10 +134426,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *159 - enterprise: *875 - installation: *876 - organization: *877 + definition: *161 + enterprise: *877 + installation: *878 + organization: *879 sender: *4 required: - action @@ -134246,13 +134451,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was updated. operationId: custom-property/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -134301,10 +134506,10 @@ x-webhooks: type: string enum: - updated - definition: *159 - enterprise: *875 - installation: *876 - organization: *877 + definition: *161 + enterprise: *877 + installation: *878 + organization: *879 sender: *4 required: - action @@ -134326,13 +134531,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to custom property values for a repository. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: The custom property values of a repository were updated. operationId: custom-property-values/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom-property-values parameters: - name: User-Agent in: header @@ -134381,19 +134586,19 @@ x-webhooks: type: string enum: - updated - enterprise: *875 - installation: *876 - repository: *878 - organization: *877 + enterprise: *877 + installation: *878 + repository: *880 + organization: *879 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *158 + items: *160 old_property_values: type: array description: The old custom property values for the repository. - items: *158 + items: *160 required: - action - repository @@ -134424,7 +134629,7 @@ x-webhooks: > This event will not occur when more than three tags are deleted at once. operationId: delete externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#delete parameters: - name: User-Agent in: header @@ -134469,18 +134674,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *875 - installation: *876 - organization: *877 - pusher_type: *886 - ref: *887 + enterprise: *877 + installation: *878 + organization: *879 + pusher_type: *888 + ref: *889 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *878 + repository: *880 sender: *4 required: - ref @@ -134505,13 +134710,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: The assignees for a Dependabot alert were updated. operationId: dependabot-alert/assignees-changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -134560,11 +134765,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *618 - installation: *876 - organization: *877 - enterprise: *875 - repository: *878 + alert: *620 + installation: *878 + organization: *879 + enterprise: *877 + repository: *880 sender: *4 required: - action @@ -134588,14 +134793,14 @@ x-webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A Dependabot alert was automatically closed by a Dependabot auto-triage rule. operationId: dependabot-alert/auto-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -134644,11 +134849,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *618 - installation: *876 - organization: *877 - enterprise: *875 - repository: *878 + alert: *620 + installation: *878 + organization: *879 + enterprise: *877 + repository: *880 sender: *4 required: - action @@ -134672,7 +134877,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A Dependabot alert, that had been automatically closed by a Dependabot @@ -134680,7 +134885,7 @@ x-webhooks: rule changed. operationId: dependabot-alert/auto-reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -134729,11 +134934,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *618 - installation: *876 - organization: *877 - enterprise: *875 - repository: *878 + alert: *620 + installation: *878 + organization: *879 + enterprise: *877 + repository: *880 sender: *4 required: - action @@ -134757,7 +134962,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A manifest file change introduced a vulnerable dependency, or a @@ -134765,7 +134970,7 @@ x-webhooks: to be vulnerable. operationId: dependabot-alert/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -134814,11 +135019,11 @@ x-webhooks: type: string enum: - created - alert: *618 - installation: *876 - organization: *877 - enterprise: *875 - repository: *878 + alert: *620 + installation: *878 + organization: *879 + enterprise: *877 + repository: *880 sender: *4 required: - action @@ -134842,13 +135047,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A Dependabot alert was manually closed. operationId: dependabot-alert/dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -134897,11 +135102,11 @@ x-webhooks: type: string enum: - dismissed - alert: *618 - installation: *876 - organization: *877 - enterprise: *875 - repository: *878 + alert: *620 + installation: *878 + organization: *879 + enterprise: *877 + repository: *880 sender: *4 required: - action @@ -134925,13 +135130,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A manifest file change removed a vulnerability. operationId: dependabot-alert/fixed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -134980,11 +135185,11 @@ x-webhooks: type: string enum: - fixed - alert: *618 - installation: *876 - organization: *877 - enterprise: *875 - repository: *878 + alert: *620 + installation: *878 + organization: *879 + enterprise: *877 + repository: *880 sender: *4 required: - action @@ -135008,14 +135213,14 @@ x-webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A manifest file change introduced a vulnerable dependency that had previously been fixed. operationId: dependabot-alert/reintroduced externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -135064,11 +135269,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *618 - installation: *876 - organization: *877 - enterprise: *875 - repository: *878 + alert: *620 + installation: *878 + organization: *879 + enterprise: *877 + repository: *880 sender: *4 required: - action @@ -135092,13 +135297,13 @@ x-webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A Dependabot alert was manually reopened. operationId: dependabot-alert/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -135147,11 +135352,11 @@ x-webhooks: type: string enum: - reopened - alert: *618 - installation: *876 - organization: *877 - enterprise: *875 - repository: *878 + alert: *620 + installation: *878 + organization: *879 + enterprise: *877 + repository: *880 sender: *4 required: - action @@ -135173,13 +135378,13 @@ x-webhooks: deploy-key-created: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deploy key was created. operationId: deploy-key/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -135228,10 +135433,10 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - key: &888 - description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) + enterprise: *877 + installation: *878 + key: &890 + description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: @@ -135266,8 +135471,8 @@ x-webhooks: - verified - created_at - read_only - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -135289,13 +135494,13 @@ x-webhooks: deploy-key-deleted: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deploy key was deleted. operationId: deploy-key/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -135344,11 +135549,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - key: *888 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + key: *890 + organization: *879 + repository: *880 sender: *4 required: - action @@ -135370,7 +135575,7 @@ x-webhooks: deployment-created: post: summary: |- - This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment status, use the `deployment_status` event. @@ -135378,7 +135583,7 @@ x-webhooks: description: A deployment was created. operationId: deployment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment parameters: - name: User-Agent in: header @@ -135429,7 +135634,7 @@ x-webhooks: - created deployment: title: Deployment - description: The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments). + description: The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments). type: object properties: created_at: @@ -135904,12 +136109,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - workflow: &894 + workflow: &896 title: Workflow type: object nullable: true @@ -136568,13 +136773,13 @@ x-webhooks: deployment-protection-rule-requested: post: summary: |- - This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments). + This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments). To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deployment protection rule was requested for an environment. operationId: deployment-protection-rule/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_protection_rule parameters: - name: User-Agent in: header @@ -136650,15 +136855,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *889 - required: *890 + properties: *891 + required: *892 nullable: true pull_requests: type: array - items: *724 - repository: *878 - organization: *877 - installation: *876 + items: *726 + repository: *880 + organization: *879 + installation: *878 sender: *4 responses: '200': @@ -136673,7 +136878,7 @@ x-webhooks: deployment-review-approved: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. @@ -136681,7 +136886,7 @@ x-webhooks: description: A deployment review was approved. operationId: deployment-review/approved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -136729,7 +136934,7 @@ x-webhooks: type: string enum: - approved - approver: &891 + approver: &893 type: object properties: avatar_url: @@ -136772,11 +136977,11 @@ x-webhooks: type: string comment: type: string - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - reviewers: &892 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + reviewers: &894 type: array items: type: object @@ -136855,7 +137060,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &893 + workflow_job_run: &895 type: object properties: conclusion: @@ -137530,7 +137735,7 @@ x-webhooks: deployment-review-rejected: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. @@ -137538,7 +137743,7 @@ x-webhooks: description: A deployment review was rejected. operationId: deployment-review/rejected externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -137586,18 +137791,18 @@ x-webhooks: type: string enum: - rejected - approver: *891 + approver: *893 comment: type: string - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - reviewers: *892 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + reviewers: *894 sender: *4 since: type: string - workflow_job_run: *893 + workflow_job_run: *895 workflow_job_runs: type: array items: @@ -138245,7 +138450,7 @@ x-webhooks: deployment-review-requested: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. @@ -138253,7 +138458,7 @@ x-webhooks: description: A deployment review was requested. operationId: deployment-review/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -138301,13 +138506,13 @@ x-webhooks: type: string enum: - requested - enterprise: *875 + enterprise: *877 environment: type: string - installation: *876 - organization: *877 - repository: *878 - requestor: &904 + installation: *878 + organization: *879 + repository: *880 + requestor: &906 title: User type: object nullable: true @@ -139116,7 +139321,7 @@ x-webhooks: deployment-status-created: post: summary: |- - This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation, use the `deployment` event. @@ -139127,7 +139332,7 @@ x-webhooks: description: A new deployment status was created. operationId: deployment-status/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_status parameters: - name: User-Agent in: header @@ -139249,7 +139454,7 @@ x-webhooks: - completed_at deployment: title: Deployment - description: The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments). + description: The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments). type: object properties: created_at: @@ -139726,7 +139931,7 @@ x-webhooks: - statuses_url - repository_url deployment_status: - description: The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses). + description: The [deployment status](https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses). type: object properties: created_at: @@ -140196,12 +140401,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - workflow: *894 + workflow: *896 workflow_run: title: Deployment Workflow Run type: object @@ -140821,7 +141026,7 @@ x-webhooks: discussion-answered: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -140832,7 +141037,7 @@ x-webhooks: description: A comment on the discussion was marked as the answer. operationId: discussion/answered externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -140881,7 +141086,7 @@ x-webhooks: type: string enum: - answered - answer: &897 + answer: &899 type: object properties: author_association: @@ -141038,11 +141243,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141065,7 +141270,7 @@ x-webhooks: discussion-category-changed: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -141076,7 +141281,7 @@ x-webhooks: description: The category of a discussion was changed. operationId: discussion/category-changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -141169,11 +141374,11 @@ x-webhooks: - from required: - category - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141196,7 +141401,7 @@ x-webhooks: discussion-closed: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -141207,7 +141412,7 @@ x-webhooks: description: A discussion was closed. operationId: discussion/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -141256,11 +141461,11 @@ x-webhooks: type: string enum: - closed - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141282,7 +141487,7 @@ x-webhooks: discussion-comment-created: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. @@ -141293,7 +141498,7 @@ x-webhooks: description: A comment on a discussion was created. operationId: discussion-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -141342,7 +141547,7 @@ x-webhooks: type: string enum: - created - comment: &896 + comment: &898 type: object properties: author_association: @@ -141499,11 +141704,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141526,7 +141731,7 @@ x-webhooks: discussion-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. @@ -141537,7 +141742,7 @@ x-webhooks: description: A comment on a discussion was deleted. operationId: discussion-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -141586,12 +141791,12 @@ x-webhooks: type: string enum: - deleted - comment: *896 - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + comment: *898 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141614,7 +141819,7 @@ x-webhooks: discussion-comment-edited: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. @@ -141625,7 +141830,7 @@ x-webhooks: description: A comment on a discussion was edited. operationId: discussion-comment/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -141686,12 +141891,12 @@ x-webhooks: - from required: - body - comment: *896 - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + comment: *898 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141715,7 +141920,7 @@ x-webhooks: discussion-created: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -141726,7 +141931,7 @@ x-webhooks: description: A discussion was created. operationId: discussion/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -141775,11 +141980,11 @@ x-webhooks: type: string enum: - created - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141801,7 +142006,7 @@ x-webhooks: discussion-deleted: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -141812,7 +142017,7 @@ x-webhooks: description: A discussion was deleted. operationId: discussion/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -141861,11 +142066,11 @@ x-webhooks: type: string enum: - deleted - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141887,7 +142092,7 @@ x-webhooks: discussion-edited: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -141899,7 +142104,7 @@ x-webhooks: the discussion was changed. operationId: discussion/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -141965,11 +142170,11 @@ x-webhooks: type: string required: - from - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -141991,7 +142196,7 @@ x-webhooks: discussion-labeled: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142002,7 +142207,7 @@ x-webhooks: description: A label was added to a discussion. operationId: discussion/labeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142051,10 +142256,10 @@ x-webhooks: type: string enum: - labeled - discussion: *895 - enterprise: *875 - installation: *876 - label: &898 + discussion: *897 + enterprise: *877 + installation: *878 + label: &900 title: Label type: object properties: @@ -142086,8 +142291,8 @@ x-webhooks: - color - default - description - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142110,7 +142315,7 @@ x-webhooks: discussion-locked: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142121,7 +142326,7 @@ x-webhooks: description: A discussion was locked. operationId: discussion/locked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142170,11 +142375,11 @@ x-webhooks: type: string enum: - locked - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142196,7 +142401,7 @@ x-webhooks: discussion-pinned: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142207,7 +142412,7 @@ x-webhooks: description: A discussion was pinned. operationId: discussion/pinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142256,11 +142461,11 @@ x-webhooks: type: string enum: - pinned - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142282,7 +142487,7 @@ x-webhooks: discussion-reopened: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142293,7 +142498,7 @@ x-webhooks: description: A discussion was reopened. operationId: discussion/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142342,11 +142547,11 @@ x-webhooks: type: string enum: - reopened - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142368,7 +142573,7 @@ x-webhooks: discussion-transferred: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142379,7 +142584,7 @@ x-webhooks: description: A discussion was transferred to another repository. operationId: discussion/transferred externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142431,16 +142636,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *895 - new_repository: *878 + new_discussion: *897 + new_repository: *880 required: - new_discussion - new_repository - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142463,7 +142668,7 @@ x-webhooks: discussion-unanswered: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142474,7 +142679,7 @@ x-webhooks: description: A comment on the discussion was unmarked as the answer. operationId: discussion/unanswered externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142523,10 +142728,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *895 - old_answer: *897 - organization: *877 - repository: *878 + discussion: *897 + old_answer: *899 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142548,7 +142753,7 @@ x-webhooks: discussion-unlabeled: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142559,7 +142764,7 @@ x-webhooks: description: A label was removed from a discussion. operationId: discussion/unlabeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142608,12 +142813,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *895 - enterprise: *875 - installation: *876 - label: *898 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + label: *900 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142636,7 +142841,7 @@ x-webhooks: discussion-unlocked: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142647,7 +142852,7 @@ x-webhooks: description: A discussion was unlocked. operationId: discussion/unlocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142696,11 +142901,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142722,7 +142927,7 @@ x-webhooks: discussion-unpinned: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -142733,7 +142938,7 @@ x-webhooks: description: A discussion was unpinned. operationId: discussion/unpinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -142782,11 +142987,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *895 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + discussion: *897 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -142814,7 +143019,7 @@ x-webhooks: description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header @@ -142855,7 +143060,7 @@ x-webhooks: required: true content: application/json: - schema: *899 + schema: *901 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142877,7 +143082,7 @@ x-webhooks: description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header @@ -142918,7 +143123,7 @@ x-webhooks: required: true content: application/json: - schema: *900 + schema: *902 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142940,7 +143145,7 @@ x-webhooks: description: A Dependabot alert dismissal request was canceled. operationId: dismissal-request-dependabot/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot parameters: - name: User-Agent in: header @@ -142981,7 +143186,7 @@ x-webhooks: required: true content: application/json: - schema: *901 + schema: *903 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143003,7 +143208,7 @@ x-webhooks: description: A Dependabot alert dismissal request was created. operationId: dismissal-request-dependabot/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot parameters: - name: User-Agent in: header @@ -143044,7 +143249,7 @@ x-webhooks: required: true content: application/json: - schema: *899 + schema: *901 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143066,7 +143271,7 @@ x-webhooks: description: A Dependabot alert dismissal request received a response. operationId: dismissal-request-dependabot/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot parameters: - name: User-Agent in: header @@ -143107,7 +143312,7 @@ x-webhooks: required: true content: application/json: - schema: *900 + schema: *902 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143132,7 +143337,7 @@ x-webhooks: description: A secret scanning alert dismissal request was canceled. operationId: dismissal-request-secret-scanning/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -143173,7 +143378,7 @@ x-webhooks: required: true content: application/json: - schema: *901 + schema: *903 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143198,7 +143403,7 @@ x-webhooks: description: A secret scanning alert dismissal request was completed. operationId: dismissal-request-secret-scanning/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -143239,7 +143444,7 @@ x-webhooks: required: true content: application/json: - schema: *902 + schema: *904 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143264,7 +143469,7 @@ x-webhooks: description: A secret scanning alert dismissal request was created. operationId: dismissal-request-secret-scanning/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -143305,7 +143510,7 @@ x-webhooks: required: true content: application/json: - schema: *899 + schema: *901 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143330,7 +143535,7 @@ x-webhooks: description: A secret scanning alert dismissal response was dismissed. operationId: dismissal-request-secret-scanning/response-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -143371,7 +143576,7 @@ x-webhooks: required: true content: application/json: - schema: *903 + schema: *905 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143396,7 +143601,7 @@ x-webhooks: description: A secret scanning alert dismissal response was submitted. operationId: dismissal-request-secret-scanning/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -143437,7 +143642,7 @@ x-webhooks: required: true content: application/json: - schema: *900 + schema: *902 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143455,13 +143660,13 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A push ruleset bypass request was cancelled. operationId: exemption-request-push-ruleset/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -143502,7 +143707,7 @@ x-webhooks: required: true content: application/json: - schema: *901 + schema: *903 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143520,13 +143725,13 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A push ruleset bypass request was completed. operationId: exemption-request-push-ruleset/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -143567,7 +143772,7 @@ x-webhooks: required: true content: application/json: - schema: *902 + schema: *904 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143585,13 +143790,13 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A push ruleset bypass request was created. operationId: exemption-request-push-ruleset/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -143632,7 +143837,7 @@ x-webhooks: required: true content: application/json: - schema: *899 + schema: *901 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143650,13 +143855,13 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A push ruleset bypass response was dismissed. operationId: exemption-request-push-ruleset/response-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -143697,7 +143902,7 @@ x-webhooks: required: true content: application/json: - schema: *903 + schema: *905 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143715,14 +143920,14 @@ x-webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A response either approving or rejecting the push ruleset bypass request was submitted. operationId: exemption-request-push-ruleset/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -143763,7 +143968,7 @@ x-webhooks: required: true content: application/json: - schema: *900 + schema: *902 responses: '200': description: Return a 200 status to indicate that the data was received @@ -143779,12 +143984,12 @@ x-webhooks: fork: post: summary: |- - This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)" in the REST API documentation. + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest/rest/repos/forks)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: fork externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#fork parameters: - name: User-Agent in: header @@ -143830,9 +144035,9 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *875 + enterprise: *877 forkee: - description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) + description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource. allOf: - title: Repository @@ -144490,9 +144695,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *876 - organization: *877 - repository: *878 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - forkee @@ -144514,15 +144719,15 @@ x-webhooks: github-app-authorization-revoked: post: summary: |- - This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. A GitHub App receives this webhook by default and cannot unsubscribe from this event. - Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." + Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." description: Someone revoked their authorization of a GitHub App. operationId: github-app-authorization/revoked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#github_app_authorization parameters: - name: User-Agent in: header @@ -144588,12 +144793,12 @@ x-webhooks: gollum: post: summary: |- - This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis)." + This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest/communities/documenting-your-project-with-wikis/about-wikis)." To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: gollum externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#gollum parameters: - name: User-Agent in: header @@ -144638,9 +144843,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 pages: description: The pages that were updated. type: array @@ -144677,7 +144882,7 @@ x-webhooks: - action - sha - html_url - repository: *878 + repository: *880 sender: *4 required: - pages @@ -144700,11 +144905,11 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Someone installed a GitHub App on a user or organization account. operationId: installation/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -144753,10 +144958,10 @@ x-webhooks: type: string enum: - created - enterprise: *875 + enterprise: *877 installation: *22 - organization: *877 - repositories: &905 + organization: *879 + repositories: &907 description: An array of repository objects that the installation can access. type: array @@ -144782,8 +144987,8 @@ x-webhooks: - name - full_name - private - repository: *878 - requester: *904 + repository: *880 + requester: *906 sender: *4 required: - action @@ -144804,12 +145009,12 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Someone uninstalled a GitHub App from their user or organization account. operationId: installation/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -144858,11 +145063,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 + enterprise: *877 installation: *22 - organization: *877 - repositories: *905 - repository: *878 + organization: *879 + repositories: *907 + repository: *880 requester: nullable: true sender: *4 @@ -144885,11 +145090,11 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Someone granted new permissions to a GitHub App. operationId: installation/new-permissions-accepted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -144938,11 +145143,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *875 + enterprise: *877 installation: *22 - organization: *877 - repositories: *905 - repository: *878 + organization: *879 + repositories: *907 + repository: *880 requester: nullable: true sender: *4 @@ -144965,11 +145170,11 @@ x-webhooks: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: A GitHub App installation was granted access to one or more repositories. operationId: installation-repositories/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header @@ -145018,10 +145223,10 @@ x-webhooks: type: string enum: - added - enterprise: *875 + enterprise: *877 installation: *22 - organization: *877 - repositories_added: &906 + organization: *879 + repositories_added: &908 description: An array of repository objects, which were added to the installation. type: array @@ -145067,15 +145272,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *878 - repository_selection: &907 + repository: *880 + repository_selection: &909 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *904 + requester: *906 sender: *4 required: - action @@ -145100,12 +145305,12 @@ x-webhooks: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Access to one or more repositories was revoked for a GitHub App installation. operationId: installation-repositories/removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header @@ -145154,10 +145359,10 @@ x-webhooks: type: string enum: - removed - enterprise: *875 + enterprise: *877 installation: *22 - organization: *877 - repositories_added: *906 + organization: *879 + repositories_added: *908 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -145184,9 +145389,9 @@ x-webhooks: - name - full_name - private - repository: *878 - repository_selection: *907 - requester: *904 + repository: *880 + repository_selection: *909 + requester: *906 sender: *4 required: - action @@ -145211,12 +145416,12 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Someone blocked access by a GitHub App to their user or organization account. operationId: installation/suspend externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -145265,11 +145470,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *875 + enterprise: *877 installation: *22 - organization: *877 - repositories: *905 - repository: *878 + organization: *879 + repositories: *907 + repository: *880 requester: nullable: true sender: *4 @@ -145291,16 +145496,16 @@ x-webhooks: post: summary: This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About - apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." + apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API - documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) - or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in + documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) + or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Somebody renamed the user or organization account that a GitHub App is installed on. operationId: installation-target/renamed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_target parameters: - name: User-Agent in: header @@ -145448,10 +145653,10 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 target_type: type: string @@ -145476,12 +145681,12 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: A GitHub App that was blocked from accessing a user or organization account was given access the account again. operationId: installation/unsuspend externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -145530,11 +145735,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *875 + enterprise: *877 installation: *22 - organization: *877 - repositories: *905 - repository: *878 + organization: *879 + repositories: *907 + repository: *880 requester: nullable: true sender: *4 @@ -145555,15 +145760,15 @@ x-webhooks: issue-comment-created: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was created. operationId: issue-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -145614,7 +145819,7 @@ x-webhooks: - created comment: title: issue comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -145658,8 +145863,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *222 - required: *223 + properties: *224 + required: *225 reactions: title: Reactions type: object @@ -145708,8 +145913,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *699 - required: *700 + properties: *701 + required: *702 nullable: true user: title: User @@ -145794,14 +145999,14 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -146584,8 +146789,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146601,7 +146806,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -146934,8 +147139,8 @@ x-webhooks: - state - locked - assignee - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -146958,15 +147163,15 @@ x-webhooks: issue-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was deleted. operationId: issue-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -147015,9 +147220,9 @@ x-webhooks: type: string enum: - deleted - comment: &908 + comment: &910 title: issue comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -147172,8 +147377,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *699 - required: *700 + properties: *701 + required: *702 nullable: true required: - url @@ -147188,14 +147393,14 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -147974,8 +148179,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147991,7 +148196,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -148326,8 +148531,8 @@ x-webhooks: - state - locked - assignee - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -148350,15 +148555,15 @@ x-webhooks: issue-comment-edited: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was edited. operationId: issue-comment/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -148407,7 +148612,7 @@ x-webhooks: type: string enum: - edited - changes: &937 + changes: &939 description: The changes to the comment. type: object properties: @@ -148419,15 +148624,15 @@ x-webhooks: type: string required: - from - comment: *908 - enterprise: *875 - installation: *876 + comment: *910 + enterprise: *877 + installation: *878 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -149209,8 +149414,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149226,7 +149431,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -149559,8 +149764,8 @@ x-webhooks: - state - locked - assignee - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -149584,15 +149789,15 @@ x-webhooks: issue-comment-pinned: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue was pinned. operationId: issue-comment/pinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -149641,15 +149846,15 @@ x-webhooks: type: string enum: - pinned - comment: *908 - enterprise: *875 - installation: *876 + comment: *910 + enterprise: *877 + installation: *878 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -150433,8 +150638,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150450,7 +150655,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -150785,8 +150990,8 @@ x-webhooks: - state - locked - assignee - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -150809,15 +151014,15 @@ x-webhooks: issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue was unpinned. operationId: issue-comment/unpinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -150866,15 +151071,15 @@ x-webhooks: type: string enum: - unpinned - comment: *908 - enterprise: *875 - installation: *876 + comment: *910 + enterprise: *877 + installation: *878 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -151658,8 +151863,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151675,7 +151880,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -152010,8 +152215,8 @@ x-webhooks: - state - locked - assignee - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -152042,7 +152247,7 @@ x-webhooks: description: An issue was marked as blocked by another issue. operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -152094,15 +152299,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 + blocked_issue: *229 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 + blocking_issue: *229 blocking_issue_repo: *80 - installation: *876 - organization: *877 - repository: *878 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -152133,7 +152338,7 @@ x-webhooks: was removed. operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -152185,15 +152390,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 + blocked_issue: *229 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 + blocking_issue: *229 blocking_issue_repo: *80 - installation: *876 - organization: *877 - repository: *878 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -152223,7 +152428,7 @@ x-webhooks: description: An issue was marked as blocking another issue. operationId: issue-dependencies/blocking-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -152275,15 +152480,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 + blocked_issue: *229 blocked_issue_repo: *80 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - installation: *876 - organization: *877 - repository: *878 + blocking_issue: *229 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -152314,7 +152519,7 @@ x-webhooks: removed. operationId: issue-dependencies/blocking-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -152366,15 +152571,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 + blocked_issue: *229 blocked_issue_repo: *80 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - installation: *876 - organization: *877 - repository: *878 + blocking_issue: *229 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -152396,7 +152601,7 @@ x-webhooks: issues-assigned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -152404,7 +152609,7 @@ x-webhooks: description: An issue was assigned to a user. operationId: issues/assigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -152454,12 +152659,12 @@ x-webhooks: type: string enum: - assigned - assignee: *904 - enterprise: *875 - installation: *876 + assignee: *906 + enterprise: *877 + installation: *878 issue: &911 title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -153246,14 +153451,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153269,7 +153474,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -153370,8 +153575,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -153393,7 +153598,7 @@ x-webhooks: issues-closed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -153401,7 +153606,7 @@ x-webhooks: description: An issue was closed. operationId: issues/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -153451,14 +153656,14 @@ x-webhooks: type: string enum: - closed - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -154246,14 +154451,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154269,7 +154474,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -154505,8 +154710,8 @@ x-webhooks: required: - state - closed_at - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -154528,7 +154733,7 @@ x-webhooks: issues-deleted: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -154536,7 +154741,7 @@ x-webhooks: description: An issue was deleted. operationId: issues/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -154585,11 +154790,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -155371,14 +155576,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155394,7 +155599,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -155494,8 +155699,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -155517,7 +155722,7 @@ x-webhooks: issues-demilestoned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -155525,7 +155730,7 @@ x-webhooks: description: An issue was removed from a milestone. operationId: issues/demilestoned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -155574,11 +155779,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -156382,14 +156587,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156405,7 +156610,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -156484,7 +156689,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &909 + milestone: &912 title: Milestone description: A collection of related issues and pull requests. type: object @@ -156622,8 +156827,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -156645,7 +156850,7 @@ x-webhooks: issues-edited: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -156653,7 +156858,7 @@ x-webhooks: description: The title or body on an issue was edited. operationId: issues/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -156722,11 +156927,11 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -157512,14 +157717,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157532,7 +157737,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *388 + type: *390 title: description: Title of the issue type: string @@ -157636,9 +157841,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *898 - organization: *877 - repository: *878 + label: *900 + organization: *879 + repository: *880 sender: *4 required: - action @@ -157658,10 +157863,343 @@ x-webhooks: - repository - organization - app + issues-field-added: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue field value was set or updated on an issue. + operationId: issues/field-added + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issues field_added event + type: object + properties: + action: + type: string + enum: + - field_added + enterprise: *877 + installation: *878 + issue: *911 + issue_field: + type: object + description: The issue field whose value was set or updated on the + issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was set or updated for the issue field. + When updating an existing value, the previous value is available + in `changes`. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present + for single_select field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + changes: + type: object + description: The previous field value, present when an existing + value was updated. + properties: + issue_field_value: + type: object + description: The previous issue field value data. + properties: + from: + type: object + description: The previous value of the issue field before + the update. + properties: + id: + type: integer + description: The unique identifier of the issue field + value. + value: + description: The previous value. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the previously selected + option. Present for single_select field types. + option: + type: object + description: The previously selected option details. + Present for single_select field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + required: + - from + organization: *879 + repository: *880 + sender: *4 + required: + - action + - issue + - issue_field + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-field-removed: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue field value was cleared from an issue. + operationId: issues/field-removed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issues field_removed event + type: object + properties: + action: + type: string + enum: + - field_removed + enterprise: *877 + installation: *878 + issue: *911 + issue_field: + type: object + description: The issue field whose value was cleared from the issue. + properties: + id: + type: integer + description: The unique identifier of the issue field. + name: + type: string + description: The name of the issue field. + field_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + required: + - id + - name + - field_type + issue_field_value: + type: object + description: The value that was cleared from the issue field. + properties: + id: + type: integer + description: The unique identifier of the issue field value. + value: + description: The value of the field. Present for text, date, + and number field types. + nullable: true + anyOf: + - type: string + - type: number + - type: integer + value_id: + type: integer + description: The identifier of the selected option. Present + for single_select field types. + option: + type: object + description: The selected option details. Present for single_select + field types. + properties: + id: + type: integer + name: + type: string + color: + type: string + description: + type: string + nullable: true + required: + - id + organization: *879 + repository: *880 + sender: *4 + required: + - action + - issue + - issue_field + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app issues-labeled: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -157669,7 +158207,7 @@ x-webhooks: description: A label was added to an issue. operationId: issues/labeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -157718,11 +158256,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -158507,14 +159045,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158527,7 +159065,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *388 + type: *390 title: description: Title of the issue type: string @@ -158631,9 +159169,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *898 - organization: *877 - repository: *878 + label: *900 + organization: *879 + repository: *880 sender: *4 required: - action @@ -158655,16 +159193,16 @@ x-webhooks: issues-locked: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations)." operationId: issues/locked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -158713,11 +159251,11 @@ x-webhooks: type: string enum: - locked - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -159526,14 +160064,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159546,7 +160084,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *388 + type: *390 title: description: Title of the issue type: string @@ -159627,8 +160165,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -159650,7 +160188,7 @@ x-webhooks: issues-milestoned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -159658,7 +160196,7 @@ x-webhooks: description: An issue was added to a milestone. operationId: issues/milestoned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -159707,11 +160245,11 @@ x-webhooks: type: string enum: - milestoned - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -160514,14 +161052,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160537,7 +161075,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -160615,9 +161153,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *909 - organization: *877 - repository: *878 + milestone: *912 + organization: *879 + repository: *880 sender: *4 required: - action @@ -160640,7 +161178,7 @@ x-webhooks: issues-opened: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -160649,7 +161187,7 @@ x-webhooks: will be `reopened` instead. operationId: issues/opened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -160703,7 +161241,7 @@ x-webhooks: properties: old_issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object nullable: true @@ -161480,11 +162018,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161512,8 +162050,8 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true user: title: User @@ -161585,7 +162123,7 @@ x-webhooks: required: - login - id - type: *388 + type: *390 required: - id - number @@ -162065,11 +162603,11 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -162850,11 +163388,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162870,7 +163408,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -162883,8 +163421,8 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true user: title: User @@ -162978,8 +163516,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -163001,16 +163539,16 @@ x-webhooks: issues-pinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." operationId: issues/pinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -163059,11 +163597,11 @@ x-webhooks: type: string enum: - pinned - enterprise: *875 - installation: *876 - issue: &910 + enterprise: *877 + installation: *878 + issue: &913 title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -163844,14 +164382,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163867,7 +164405,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -163967,8 +164505,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -163990,7 +164528,7 @@ x-webhooks: issues-reopened: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -163998,7 +164536,7 @@ x-webhooks: description: A closed issue was reopened. operationId: issues/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -164047,11 +164585,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -164858,14 +165396,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164959,9 +165497,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *388 - organization: *877 - repository: *878 + type: *390 + organization: *879 + repository: *880 sender: *4 required: - action @@ -164983,16 +165521,16 @@ x-webhooks: issues-transferred: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." operationId: issues/transferred externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -165046,7 +165584,7 @@ x-webhooks: properties: new_issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -165827,14 +166365,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -165850,7 +166388,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -166429,11 +166967,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *875 - installation: *876 - issue: *910 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + issue: *913 + organization: *879 + repository: *880 sender: *4 required: - action @@ -166456,7 +166994,7 @@ x-webhooks: issues-typed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -166464,7 +167002,7 @@ x-webhooks: description: An issue type was added to an issue. operationId: issues/typed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -166513,12 +167051,12 @@ x-webhooks: type: string enum: - typed - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: *911 - type: *388 - organization: *877 - repository: *878 + type: *390 + organization: *879 + repository: *880 sender: *4 required: - action @@ -166541,7 +167079,7 @@ x-webhooks: issues-unassigned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -166549,7 +167087,7 @@ x-webhooks: description: A user was unassigned from an issue. operationId: issues/unassigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -166599,7 +167137,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &940 + assignee: &942 title: User type: object nullable: true @@ -166669,11 +167207,11 @@ x-webhooks: required: - login - id - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: *911 - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -166695,7 +167233,7 @@ x-webhooks: issues-unlabeled: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -166703,7 +167241,7 @@ x-webhooks: description: A label was removed from an issue. operationId: issues/unlabeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -166752,12 +167290,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: *911 - label: *898 - organization: *877 - repository: *878 + label: *900 + organization: *879 + repository: *880 sender: *4 required: - action @@ -166779,16 +167317,16 @@ x-webhooks: issues-unlocked: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations)." operationId: issues/unlocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -166837,11 +167375,11 @@ x-webhooks: type: string enum: - unlocked - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -167648,14 +168186,14 @@ x-webhooks: description: Comments provide a way for people to collaborate on an issue. type: object - properties: *228 - required: *229 + properties: *230 + required: *231 nullable: true - sub_issues_summary: *815 - issue_dependencies_summary: *816 + sub_issues_summary: *817 + issue_dependencies_summary: *818 issue_field_values: type: array - items: *683 + items: *685 state: description: State of the issue; either 'open' or 'closed' type: string @@ -167671,7 +168209,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *388 + type: *390 updated_at: type: string format: date-time @@ -167749,8 +168287,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -167772,16 +168310,16 @@ x-webhooks: issues-unpinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." operationId: issues/unpinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -167830,11 +168368,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *875 - installation: *876 - issue: *910 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + issue: *913 + organization: *879 + repository: *880 sender: *4 required: - action @@ -167856,7 +168394,7 @@ x-webhooks: issues-untyped: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -167864,7 +168402,7 @@ x-webhooks: description: An issue type was removed from an issue. operationId: issues/untyped externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -167913,12 +168451,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 issue: *911 - type: *388 - organization: *877 - repository: *878 + type: *390 + organization: *879 + repository: *880 sender: *4 required: - action @@ -167941,7 +168479,7 @@ x-webhooks: label-created: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. @@ -167949,7 +168487,7 @@ x-webhooks: description: A label was created. operationId: label/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -167998,11 +168536,11 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - label: *898 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + label: *900 + organization: *879 + repository: *880 sender: *4 required: - action @@ -168023,7 +168561,7 @@ x-webhooks: label-deleted: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. @@ -168031,7 +168569,7 @@ x-webhooks: description: A label was deleted. operationId: label/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -168080,11 +168618,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - label: *898 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + label: *900 + organization: *879 + repository: *880 sender: *4 required: - action @@ -168106,7 +168644,7 @@ x-webhooks: label-edited: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. @@ -168114,7 +168652,7 @@ x-webhooks: description: A label's name, description, or color was changed. operationId: label/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -168194,11 +168732,11 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 - label: *898 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + label: *900 + organization: *879 + repository: *880 sender: *4 required: - action @@ -168220,16 +168758,16 @@ x-webhooks: marketplace-purchase-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately. operationId: marketplace-purchase/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -168280,9 +168818,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *875 - installation: *876 - marketplace_purchase: &912 + enterprise: *877 + installation: *878 + marketplace_purchase: &914 title: Marketplace Purchase type: object required: @@ -168365,8 +168903,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *877 - previous_marketplace_purchase: &913 + organization: *879 + previous_marketplace_purchase: &915 title: Marketplace Purchase type: object properties: @@ -168446,7 +168984,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *878 + repository: *880 sender: *4 required: - action @@ -168466,16 +169004,16 @@ x-webhooks: marketplace-purchase-changed: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately. operationId: marketplace-purchase/changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -168526,10 +169064,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *875 - installation: *876 - marketplace_purchase: *912 - organization: *877 + enterprise: *877 + installation: *878 + marketplace_purchase: *914 + organization: *879 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -168612,7 +169150,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *878 + repository: *880 sender: *4 required: - action @@ -168632,10 +169170,10 @@ x-webhooks: marketplace-purchase-pending-change: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing @@ -168643,7 +169181,7 @@ x-webhooks: be sent. operationId: marketplace-purchase/pending-change externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -168694,10 +169232,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *875 - installation: *876 - marketplace_purchase: *912 - organization: *877 + enterprise: *877 + installation: *878 + marketplace_purchase: *914 + organization: *879 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -168779,7 +169317,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *878 + repository: *880 sender: *4 required: - action @@ -168799,17 +169337,17 @@ x-webhooks: marketplace-purchase-pending-change-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle. operationId: marketplace-purchase/pending-change-cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -168860,8 +169398,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 marketplace_purchase: title: Marketplace Purchase type: object @@ -168943,9 +169481,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *877 - previous_marketplace_purchase: *913 - repository: *878 + organization: *879 + previous_marketplace_purchase: *915 + repository: *880 sender: *4 required: - action @@ -168965,16 +169503,16 @@ x-webhooks: marketplace-purchase-purchased: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately. operationId: marketplace-purchase/purchased externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -169025,12 +169563,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *875 - installation: *876 - marketplace_purchase: *912 - organization: *877 - previous_marketplace_purchase: *913 - repository: *878 + enterprise: *877 + installation: *878 + marketplace_purchase: *914 + organization: *879 + previous_marketplace_purchase: *915 + repository: *880 sender: *4 required: - action @@ -169050,13 +169588,13 @@ x-webhooks: member-added: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A GitHub user accepted an invitation to a repository. operationId: member/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -169132,11 +169670,11 @@ x-webhooks: type: string required: - to - enterprise: *875 - installation: *876 - member: *904 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + member: *906 + organization: *879 + repository: *880 sender: *4 required: - action @@ -169159,13 +169697,13 @@ x-webhooks: member-edited: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: Permissions were changed for a collaborator on a repository. operationId: member/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -169236,11 +169774,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *875 - installation: *876 - member: *904 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + member: *906 + organization: *879 + repository: *880 sender: *4 required: - action @@ -169264,13 +169802,13 @@ x-webhooks: member-removed: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A collaborator was removed from a repository. operationId: member/removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -169319,11 +169857,11 @@ x-webhooks: type: string enum: - removed - enterprise: *875 - installation: *876 - member: *904 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + member: *906 + organization: *879 + repository: *880 sender: *4 required: - action @@ -169346,13 +169884,13 @@ x-webhooks: membership-added: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization member was added to a team. operationId: membership/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -169401,11 +169939,11 @@ x-webhooks: type: string enum: - added - enterprise: *875 - installation: *876 - member: *904 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + member: *906 + organization: *879 + repository: *880 scope: description: The scope of the membership. Currently, can only be `team`. @@ -169481,7 +170019,7 @@ x-webhooks: required: - login - id - team: &914 + team: &916 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -169649,13 +170187,13 @@ x-webhooks: membership-removed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization member was removed from a team. operationId: membership/removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -169704,11 +170242,11 @@ x-webhooks: type: string enum: - removed - enterprise: *875 - installation: *876 - member: *904 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + member: *906 + organization: *879 + repository: *880 scope: description: The scope of the membership. Currently, can only be `team`. @@ -169785,7 +170323,7 @@ x-webhooks: required: - login - id - team: *914 + team: *916 required: - action - scope @@ -169808,7 +170346,7 @@ x-webhooks: merge-group-checks-requested: post: summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. description: |- @@ -169819,7 +170357,7 @@ x-webhooks: tags: - merge-queue externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -169867,8 +170405,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *876 - merge_group: &916 + installation: *878 + merge_group: &918 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -169887,15 +170425,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *915 + head_commit: *917 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -169913,7 +170451,7 @@ x-webhooks: merge-group-destroyed: post: summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. description: |- @@ -169924,7 +170462,7 @@ x-webhooks: tags: - merge-queue externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -169981,10 +170519,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *876 - merge_group: *916 - organization: *877 - repository: *878 + installation: *878 + merge_group: *918 + organization: *879 + repository: *880 sender: *4 required: - action @@ -170008,7 +170546,7 @@ x-webhooks: description: The webhook was deleted. operationId: meta/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#meta parameters: - name: User-Agent in: header @@ -170057,7 +170595,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 + enterprise: *877 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -170166,16 +170704,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *876 - organization: *877 + installation: *878 + organization: *879 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *917 - required: *918 + properties: *919 + required: *920 nullable: true sender: *4 required: @@ -170199,7 +170737,7 @@ x-webhooks: milestone-closed: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -170207,7 +170745,7 @@ x-webhooks: description: A milestone was closed. operationId: milestone/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -170256,11 +170794,11 @@ x-webhooks: type: string enum: - closed - enterprise: *875 - installation: *876 - milestone: *909 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + milestone: *912 + organization: *879 + repository: *880 sender: *4 required: - action @@ -170282,7 +170820,7 @@ x-webhooks: milestone-created: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -170290,7 +170828,7 @@ x-webhooks: description: A milestone was created. operationId: milestone/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -170339,9 +170877,9 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - milestone: &919 + enterprise: *877 + installation: *878 + milestone: &921 title: Milestone description: A collection of related issues and pull requests. type: object @@ -170478,8 +171016,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -170501,7 +171039,7 @@ x-webhooks: milestone-deleted: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -170509,7 +171047,7 @@ x-webhooks: description: A milestone was deleted. operationId: milestone/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -170558,11 +171096,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - milestone: *909 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + milestone: *912 + organization: *879 + repository: *880 sender: *4 required: - action @@ -170584,7 +171122,7 @@ x-webhooks: milestone-edited: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -170592,7 +171130,7 @@ x-webhooks: description: A milestone was edited. operationId: milestone/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -170672,11 +171210,11 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 - milestone: *909 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + milestone: *912 + organization: *879 + repository: *880 sender: *4 required: - action @@ -170699,7 +171237,7 @@ x-webhooks: milestone-opened: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -170707,7 +171245,7 @@ x-webhooks: description: A milestone was opened. operationId: milestone/opened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -170756,11 +171294,11 @@ x-webhooks: type: string enum: - opened - enterprise: *875 - installation: *876 - milestone: *919 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + milestone: *921 + organization: *879 + repository: *880 sender: *4 required: - action @@ -170782,7 +171320,7 @@ x-webhooks: org-block-blocked: post: summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)" in the REST API documentation. If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. @@ -170790,7 +171328,7 @@ x-webhooks: description: A user was blocked from the organization. operationId: org-block/blocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -170839,11 +171377,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *904 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + blocked_user: *906 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -170865,7 +171403,7 @@ x-webhooks: org-block-unblocked: post: summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)" in the REST API documentation. If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. @@ -170873,7 +171411,7 @@ x-webhooks: description: A previously blocked user was unblocked from the organization. operationId: org-block/unblocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -170922,11 +171460,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *904 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + blocked_user: *906 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -170952,7 +171490,7 @@ x-webhooks: description: A new organization custom property was created. operationId: organization-custom-property/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -171001,8 +171539,8 @@ x-webhooks: type: string enum: - created - definition: *154 - enterprise: *875 + definition: *156 + enterprise: *877 sender: *4 required: - action @@ -171025,7 +171563,7 @@ x-webhooks: description: An organization custom property was deleted. operationId: organization-custom-property/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -171082,8 +171620,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 sender: *4 required: - action @@ -171106,7 +171644,7 @@ x-webhooks: description: An organization custom property was updated. operationId: organization-custom-property/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -171155,9 +171693,9 @@ x-webhooks: type: string enum: - updated - definition: *154 - enterprise: *875 - installation: *876 + definition: *156 + enterprise: *877 + installation: *878 sender: *4 required: - action @@ -171180,7 +171718,7 @@ x-webhooks: description: The custom property values of an organization were updated. operationId: organization-custom-property-values/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization-custom-property-values parameters: - name: User-Agent in: header @@ -171229,18 +171767,18 @@ x-webhooks: type: string enum: - updated - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 sender: *4 new_property_values: type: array description: The new custom property values. - items: *158 + items: *160 old_property_values: type: array description: The old custom property values. - items: *158 + items: *160 required: - action - organization @@ -171262,7 +171800,7 @@ x-webhooks: organization-deleted: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -171270,7 +171808,7 @@ x-webhooks: description: An organization was deleted. operationId: organization/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -171319,9 +171857,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - membership: &920 + enterprise: *877 + installation: *878 + membership: &922 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -171428,8 +171966,8 @@ x-webhooks: - role - organization_url - user - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -171450,7 +171988,7 @@ x-webhooks: organization-member-added: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -171458,7 +171996,7 @@ x-webhooks: description: A member accepted an invitation to join an organization. operationId: organization/member-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -171507,11 +172045,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *875 - installation: *876 - membership: *920 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + membership: *922 + organization: *879 + repository: *880 sender: *4 required: - action @@ -171533,7 +172071,7 @@ x-webhooks: organization-member-invited: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -171541,7 +172079,7 @@ x-webhooks: description: A member was invited to join the organization. operationId: organization/member-invited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -171590,8 +172128,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -171707,10 +172245,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 - user: *904 + user: *906 required: - action - invitation @@ -171731,7 +172269,7 @@ x-webhooks: organization-member-removed: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -171739,7 +172277,7 @@ x-webhooks: description: A member was removed from the organization. operationId: organization/member-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -171788,11 +172326,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *875 - installation: *876 - membership: *920 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + membership: *922 + organization: *879 + repository: *880 sender: *4 required: - action @@ -171814,7 +172352,7 @@ x-webhooks: organization-renamed: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -171822,7 +172360,7 @@ x-webhooks: description: The name of an organization was changed. operationId: organization/renamed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -171879,11 +172417,11 @@ x-webhooks: properties: from: type: string - enterprise: *875 - installation: *876 - membership: *920 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + membership: *922 + organization: *879 + repository: *880 sender: *4 required: - action @@ -171904,15 +172442,15 @@ x-webhooks: package-published: post: summary: This event occurs when there is activity relating to GitHub Packages. - For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." + For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL - API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) - or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" + API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) + or "[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)" in the REST API documentation. description: A package was published to a registry. operationId: package/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header @@ -171961,9 +172499,9 @@ x-webhooks: type: string enum: - published - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 package: description: Information about the package. type: object @@ -172462,7 +173000,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &921 + items: &923 title: Ruby Gems metadata type: object properties: @@ -172557,7 +173095,7 @@ x-webhooks: - owner - package_version - registry - repository: *878 + repository: *880 sender: *4 required: - action @@ -172577,15 +173115,15 @@ x-webhooks: package-updated: post: summary: This event occurs when there is activity relating to GitHub Packages. - For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." + For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL - API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) - or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" + API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) + or "[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)" in the REST API documentation. description: A previously published package was updated. operationId: package/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header @@ -172634,9 +173172,9 @@ x-webhooks: type: string enum: - updated - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 package: description: Information about the package. type: object @@ -172989,7 +173527,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *921 + items: *923 source_url: type: string format: uri @@ -173059,7 +173597,7 @@ x-webhooks: - owner - package_version - registry - repository: *878 + repository: *880 sender: *4 required: - action @@ -173080,12 +173618,12 @@ x-webhooks: page-build: post: summary: |- - This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)" in the REST API documentation. + This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/enterprise-cloud@latest/rest/pages)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. operationId: page-build externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#page_build parameters: - name: User-Agent in: header @@ -173131,7 +173669,7 @@ x-webhooks: type: object properties: build: - description: The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-github-pages-builds) + description: The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-github-pages-builds) itself. type: object properties: @@ -173235,12 +173773,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *875 + enterprise: *877 id: type: integer - installation: *876 - organization: *877 - repository: *878 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - id @@ -173262,13 +173800,13 @@ x-webhooks: personal-access-token-request-approved: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was approved. operationId: personal-access-token-request/approved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header @@ -173317,7 +173855,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &922 + personal_access_token_request: &924 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -173463,10 +174001,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *875 - organization: *877 + enterprise: *877 + organization: *879 sender: *4 - installation: *876 + installation: *878 required: - action - personal_access_token_request @@ -173487,14 +174025,14 @@ x-webhooks: personal-access-token-request-cancelled: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was cancelled by the requester. operationId: personal-access-token-request/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header @@ -173543,11 +174081,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *922 - enterprise: *875 - organization: *877 + personal_access_token_request: *924 + enterprise: *877 + organization: *879 sender: *4 - installation: *876 + installation: *878 required: - action - personal_access_token_request @@ -173568,13 +174106,13 @@ x-webhooks: personal-access-token-request-created: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was created. operationId: personal-access-token-request/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header @@ -173623,11 +174161,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *922 - enterprise: *875 - organization: *877 + personal_access_token_request: *924 + enterprise: *877 + organization: *879 sender: *4 - installation: *876 + installation: *878 required: - action - personal_access_token_request @@ -173647,13 +174185,13 @@ x-webhooks: personal-access-token-request-denied: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was denied. operationId: personal-access-token-request/denied externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header @@ -173702,11 +174240,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *922 - organization: *877 - enterprise: *875 + personal_access_token_request: *924 + organization: *879 + enterprise: *877 sender: *4 - installation: *876 + installation: *878 required: - action - personal_access_token_request @@ -173730,7 +174268,7 @@ x-webhooks: a confirmation from GitHub that you configured the webhook correctly. operationId: ping externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#ping parameters: - name: User-Agent in: header @@ -173811,7 +174349,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *923 + last_response: *925 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -173843,8 +174381,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 zen: description: Random string of GitHub zen. @@ -174018,7 +174556,7 @@ x-webhooks: project-card-converted: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -174028,7 +174566,7 @@ x-webhooks: description: A note in a project (classic) was converted to an issue. operationId: project-card/converted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -174089,10 +174627,10 @@ x-webhooks: - from required: - note - enterprise: *875 - installation: *876 - organization: *877 - project_card: &924 + enterprise: *877 + installation: *878 + organization: *879 + project_card: &926 title: Project Card type: object properties: @@ -174211,7 +174749,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *878 + repository: *880 sender: *4 required: - action @@ -174233,7 +174771,7 @@ x-webhooks: project-card-created: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -174243,7 +174781,7 @@ x-webhooks: description: A card was added to a project (classic). operationId: project-card/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -174292,11 +174830,11 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - project_card: *924 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + project_card: *926 + repository: *880 sender: *4 required: - action @@ -174317,7 +174855,7 @@ x-webhooks: project-card-deleted: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -174327,7 +174865,7 @@ x-webhooks: description: A card on a project (classic) was deleted. operationId: project-card/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -174376,9 +174914,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 project_card: title: Project Card type: object @@ -174506,8 +175044,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *917 - required: *918 + properties: *919 + required: *920 nullable: true sender: *4 required: @@ -174529,7 +175067,7 @@ x-webhooks: project-card-edited: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -174539,7 +175077,7 @@ x-webhooks: description: A note on a project (classic) was edited. operationId: project-card/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -174601,11 +175139,11 @@ x-webhooks: - from required: - note - enterprise: *875 - installation: *876 - organization: *877 - project_card: *924 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + project_card: *926 + repository: *880 sender: *4 required: - action @@ -174627,7 +175165,7 @@ x-webhooks: project-card-moved: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -174638,7 +175176,7 @@ x-webhooks: another position in its column. operationId: project-card/moved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -174699,9 +175237,9 @@ x-webhooks: - from required: - column_id - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 project_card: allOf: - title: Project Card @@ -174891,7 +175429,7 @@ x-webhooks: type: string required: - after_id - repository: *878 + repository: *880 sender: *4 required: - action @@ -174912,7 +175450,7 @@ x-webhooks: project-closed: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -174922,7 +175460,7 @@ x-webhooks: description: A project (classic) was closed. operationId: project/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -174971,10 +175509,10 @@ x-webhooks: type: string enum: - closed - enterprise: *875 - installation: *876 - organization: *877 - project: &926 + enterprise: *877 + installation: *878 + organization: *879 + project: &928 title: Project type: object properties: @@ -175098,7 +175636,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *878 + repository: *880 sender: *4 required: - action @@ -175119,7 +175657,7 @@ x-webhooks: project-column-created: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. @@ -175129,7 +175667,7 @@ x-webhooks: description: A column was added to a project (classic). operationId: project-column/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -175178,10 +175716,10 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - project_column: &925 + enterprise: *877 + installation: *878 + organization: *879 + project_column: &927 title: Project Column type: object properties: @@ -175220,7 +175758,7 @@ x-webhooks: - name - created_at - updated_at - repository: *878 + repository: *880 sender: *4 required: - action @@ -175240,7 +175778,7 @@ x-webhooks: project-column-deleted: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. @@ -175250,7 +175788,7 @@ x-webhooks: description: A column was deleted from a project (classic). operationId: project-column/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -175299,18 +175837,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 - project_column: *925 + enterprise: *877 + installation: *878 + organization: *879 + project_column: *927 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *917 - required: *918 + properties: *919 + required: *920 nullable: true sender: *4 required: @@ -175331,7 +175869,7 @@ x-webhooks: project-column-edited: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. @@ -175341,7 +175879,7 @@ x-webhooks: description: The name of a column on a project (classic) was changed. operationId: project-column/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -175400,11 +175938,11 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 - organization: *877 - project_column: *925 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + project_column: *927 + repository: *880 sender: *4 required: - action @@ -175425,7 +175963,7 @@ x-webhooks: project-column-moved: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. @@ -175435,7 +175973,7 @@ x-webhooks: description: A column was moved to a new position on a project (classic). operationId: project-column/moved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -175484,11 +176022,11 @@ x-webhooks: type: string enum: - moved - enterprise: *875 - installation: *876 - organization: *877 - project_column: *925 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + project_column: *927 + repository: *880 sender: *4 required: - action @@ -175509,7 +176047,7 @@ x-webhooks: project-created: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -175519,7 +176057,7 @@ x-webhooks: description: A project (classic) was created. operationId: project/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -175568,11 +176106,11 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - project: *926 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + project: *928 + repository: *880 sender: *4 required: - action @@ -175593,7 +176131,7 @@ x-webhooks: project-deleted: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -175603,7 +176141,7 @@ x-webhooks: description: A project (classic) was deleted. operationId: project/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -175652,18 +176190,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 - project: *926 + enterprise: *877 + installation: *878 + organization: *879 + project: *928 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *917 - required: *918 + properties: *919 + required: *920 nullable: true sender: *4 required: @@ -175684,7 +176222,7 @@ x-webhooks: project-edited: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -175694,7 +176232,7 @@ x-webhooks: description: The name or description of a project (classic) was changed. operationId: project/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -175765,11 +176303,11 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 - organization: *877 - project: *926 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + project: *928 + repository: *880 sender: *4 required: - action @@ -175789,7 +176327,7 @@ x-webhooks: project-reopened: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -175799,7 +176337,7 @@ x-webhooks: description: A project (classic) was closed. operationId: project/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -175848,11 +176386,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *875 - installation: *876 - organization: *877 - project: *926 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + project: *928 + repository: *880 sender: *4 required: - action @@ -175873,7 +176411,7 @@ x-webhooks: projects-v2-closed: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -175884,7 +176422,7 @@ x-webhooks: description: A project in the organization was closed. operationId: projects-v2/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -175933,9 +176471,9 @@ x-webhooks: type: string enum: - closed - installation: *876 - organization: *877 - projects_v2: *420 + installation: *878 + organization: *879 + projects_v2: *422 sender: *4 required: - action @@ -175956,7 +176494,7 @@ x-webhooks: projects-v2-created: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -175967,7 +176505,7 @@ x-webhooks: description: A project in the organization was created. operationId: projects-v2/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -176016,9 +176554,9 @@ x-webhooks: type: string enum: - created - installation: *876 - organization: *877 - projects_v2: *420 + installation: *878 + organization: *879 + projects_v2: *422 sender: *4 required: - action @@ -176039,7 +176577,7 @@ x-webhooks: projects-v2-deleted: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176050,7 +176588,7 @@ x-webhooks: description: A project in the organization was deleted. operationId: projects-v2/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -176099,9 +176637,9 @@ x-webhooks: type: string enum: - deleted - installation: *876 - organization: *877 - projects_v2: *420 + installation: *878 + organization: *879 + projects_v2: *422 sender: *4 required: - action @@ -176122,7 +176660,7 @@ x-webhooks: projects-v2-edited: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176134,7 +176672,7 @@ x-webhooks: was changed. operationId: projects-v2/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -176218,9 +176756,9 @@ x-webhooks: type: string to: type: string - installation: *876 - organization: *877 - projects_v2: *420 + installation: *878 + organization: *879 + projects_v2: *422 sender: *4 required: - action @@ -176242,7 +176780,7 @@ x-webhooks: projects-v2-item-archived: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176251,10 +176789,10 @@ x-webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item on an organization project was archived. For more information, - see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." operationId: projects-v2-item/archived externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -176303,7 +176841,7 @@ x-webhooks: type: string enum: - archived - changes: &930 + changes: &932 type: object properties: archived_at: @@ -176317,9 +176855,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *876 - organization: *877 - projects_v2_item: &927 + installation: *878 + organization: *879 + projects_v2_item: &929 title: Projects v2 Item description: An item belonging to a project type: object @@ -176337,7 +176875,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *427 + content_type: *429 creator: *4 created_at: type: string @@ -176383,7 +176921,7 @@ x-webhooks: projects-v2-item-converted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176394,7 +176932,7 @@ x-webhooks: description: A draft issue in an organization project was converted to an issue. operationId: projects-v2-item/converted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -176454,9 +176992,9 @@ x-webhooks: nullable: true to: type: string - installation: *876 - organization: *877 - projects_v2_item: *927 + installation: *878 + organization: *879 + projects_v2_item: *929 sender: *4 required: - action @@ -176478,7 +177016,7 @@ x-webhooks: projects-v2-item-created: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176489,7 +177027,7 @@ x-webhooks: description: An item was added to a project in the organization. operationId: projects-v2-item/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -176538,9 +177076,9 @@ x-webhooks: type: string enum: - created - installation: *876 - organization: *877 - projects_v2_item: *927 + installation: *878 + organization: *879 + projects_v2_item: *929 sender: *4 required: - action @@ -176561,7 +177099,7 @@ x-webhooks: projects-v2-item-deleted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176572,7 +177110,7 @@ x-webhooks: description: An item was deleted from a project in the organization. operationId: projects-v2-item/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -176621,9 +177159,9 @@ x-webhooks: type: string enum: - deleted - installation: *876 - organization: *877 - projects_v2_item: *927 + installation: *878 + organization: *879 + projects_v2_item: *929 sender: *4 required: - action @@ -176644,7 +177182,7 @@ x-webhooks: projects-v2-item-edited: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176657,7 +177195,7 @@ x-webhooks: issue was changed, or a draft issue was converted to an issue. operationId: projects-v2-item/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -176729,7 +177267,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &928 + - &930 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -176751,7 +177289,7 @@ x-webhooks: required: - id - name - - &929 + - &931 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -176785,8 +177323,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *928 - - *929 + - *930 + - *931 required: - field_value - type: object @@ -176802,9 +177340,9 @@ x-webhooks: nullable: true required: - body - installation: *876 - organization: *877 - projects_v2_item: *927 + installation: *878 + organization: *879 + projects_v2_item: *929 sender: *4 required: - action @@ -176825,7 +177363,7 @@ x-webhooks: projects-v2-item-reordered: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176838,7 +177376,7 @@ x-webhooks: board layout. operationId: projects-v2-item/reordered externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -176899,9 +177437,9 @@ x-webhooks: to: type: string nullable: true - installation: *876 - organization: *877 - projects_v2_item: *927 + installation: *878 + organization: *879 + projects_v2_item: *929 sender: *4 required: - action @@ -176923,7 +177461,7 @@ x-webhooks: projects-v2-item-restored: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -176932,10 +177470,10 @@ x-webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An archived item on an organization project was restored from the - archive. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + archive. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." operationId: projects-v2-item/restored externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -176984,10 +177522,10 @@ x-webhooks: type: string enum: - restored - changes: *930 - installation: *876 - organization: *877 - projects_v2_item: *927 + changes: *932 + installation: *878 + organization: *879 + projects_v2_item: *929 sender: *4 required: - action @@ -177009,7 +177547,7 @@ x-webhooks: projects-v2-reopened: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -177020,7 +177558,7 @@ x-webhooks: description: A project in the organization was reopened. operationId: projects-v2/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -177069,9 +177607,9 @@ x-webhooks: type: string enum: - reopened - installation: *876 - organization: *877 - projects_v2: *420 + installation: *878 + organization: *879 + projects_v2: *422 sender: *4 required: - action @@ -177092,7 +177630,7 @@ x-webhooks: projects-v2-status-update-created: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. @@ -177103,7 +177641,7 @@ x-webhooks: description: A status update was added to a project in the organization. operationId: projects-v2-status-update/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -177152,14 +177690,14 @@ x-webhooks: type: string enum: - created - installation: *876 - organization: *877 - projects_v2_status_update: &933 + installation: *878 + organization: *879 + projects_v2_status_update: &935 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *931 - required: *932 + properties: *933 + required: *934 sender: *4 required: - action @@ -177180,7 +177718,7 @@ x-webhooks: projects-v2-status-update-deleted: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. @@ -177191,7 +177729,7 @@ x-webhooks: description: A status update was removed from a project in the organization. operationId: projects-v2-status-update/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -177240,9 +177778,9 @@ x-webhooks: type: string enum: - deleted - installation: *876 - organization: *877 - projects_v2_status_update: *933 + installation: *878 + organization: *879 + projects_v2_status_update: *935 sender: *4 required: - action @@ -177263,7 +177801,7 @@ x-webhooks: projects-v2-status-update-edited: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. @@ -177274,7 +177812,7 @@ x-webhooks: description: A status update was edited on a project in the organization. operationId: projects-v2-status-update/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -177378,9 +177916,9 @@ x-webhooks: type: string format: date nullable: true - installation: *876 - organization: *877 - projects_v2_status_update: *933 + installation: *878 + organization: *879 + projects_v2_status_update: *935 sender: *4 required: - action @@ -177401,12 +177939,12 @@ x-webhooks: public: post: summary: |- - This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." + This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. operationId: public externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#public parameters: - name: User-Agent in: header @@ -177451,10 +177989,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - repository @@ -177474,7 +178012,7 @@ x-webhooks: pull-request-assigned: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -177482,7 +178020,7 @@ x-webhooks: description: A pull request was assigned to a user. operationId: pull-request/assigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -177531,13 +178069,13 @@ x-webhooks: type: string enum: - assigned - assignee: *904 - enterprise: *875 - installation: *876 - number: &934 + assignee: *906 + enterprise: *877 + installation: *878 + number: &936 description: The pull request number. type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -179842,7 +180380,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -179866,16 +180404,16 @@ x-webhooks: pull-request-auto-merge-disabled: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Auto merge was disabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." operationId: pull-request/auto-merge-disabled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -179924,11 +180462,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 number: type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -182228,7 +182766,7 @@ x-webhooks: - draft reason: type: string - repository: *878 + repository: *880 sender: *4 required: - action @@ -182252,16 +182790,16 @@ x-webhooks: pull-request-auto-merge-enabled: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Auto merge was enabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." operationId: pull-request/auto-merge-enabled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -182310,11 +182848,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 number: type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -184614,7 +185152,7 @@ x-webhooks: - draft reason: type: string - repository: *878 + repository: *880 sender: *4 required: - action @@ -184637,7 +185175,7 @@ x-webhooks: pull-request-closed: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -184647,7 +185185,7 @@ x-webhooks: true in the webhook payload, the pull request was merged. operationId: pull-request/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -184696,13 +185234,13 @@ x-webhooks: type: string enum: - closed - enterprise: *875 - installation: *876 - number: *934 - organization: *877 - pull_request: &935 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 + pull_request: &937 allOf: - - *724 + - *726 - type: object properties: allow_auto_merge: @@ -184764,7 +185302,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *878 + repository: *880 sender: *4 required: - action @@ -184787,16 +185325,16 @@ x-webhooks: pull-request-converted-to-draft: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was converted to a draft. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." operationId: pull-request/converted-to-draft externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -184845,12 +185383,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *875 - installation: *876 - number: *934 - organization: *877 - pull_request: *935 - repository: *878 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 + pull_request: *937 + repository: *880 sender: *4 required: - action @@ -184873,7 +185411,7 @@ x-webhooks: pull-request-demilestoned: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -184881,7 +185419,7 @@ x-webhooks: description: A pull request was removed from a milestone. operationId: pull-request/demilestoned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -184930,11 +185468,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *875 - milestone: *706 - number: *934 - organization: *877 - pull_request: &936 + enterprise: *877 + milestone: *708 + number: *936 + organization: *879 + pull_request: &938 title: Pull Request type: object properties: @@ -187219,7 +187757,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -187241,7 +187779,7 @@ x-webhooks: pull-request-dequeued: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -187249,7 +187787,7 @@ x-webhooks: description: A pull request was removed from the merge queue. operationId: pull-request/dequeued externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -187298,11 +187836,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 number: type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -189606,7 +190144,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *878 + repository: *880 sender: *4 required: - action @@ -189630,7 +190168,7 @@ x-webhooks: pull-request-edited: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -189639,7 +190177,7 @@ x-webhooks: of a pull request was changed. operationId: pull-request/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -189730,12 +190268,12 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 - number: *934 - organization: *877 - pull_request: *935 - repository: *878 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 + pull_request: *937 + repository: *880 sender: *4 required: - action @@ -189758,7 +190296,7 @@ x-webhooks: pull-request-enqueued: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -189766,7 +190304,7 @@ x-webhooks: description: A pull request was added to the merge queue. operationId: pull-request/enqueued externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -189815,11 +190353,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 number: type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -192108,7 +192646,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -192131,7 +192669,7 @@ x-webhooks: pull-request-labeled: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -192139,7 +192677,7 @@ x-webhooks: description: A label was added to a pull request. operationId: pull-request/labeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -192188,11 +192726,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *875 - installation: *876 - label: *898 - number: *934 - organization: *877 + enterprise: *877 + installation: *878 + label: *900 + number: *936 + organization: *879 pull_request: title: Pull Request type: object @@ -194496,7 +195034,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -194519,16 +195057,16 @@ x-webhooks: pull-request-locked: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Conversation on a pull request was locked. For more information, - see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations)." operationId: pull-request/locked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -194577,10 +195115,10 @@ x-webhooks: type: string enum: - locked - enterprise: *875 - installation: *876 - number: *934 - organization: *877 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 pull_request: title: Pull Request type: object @@ -196882,7 +197420,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -196905,7 +197443,7 @@ x-webhooks: pull-request-milestoned: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -196913,7 +197451,7 @@ x-webhooks: description: A pull request was added to a milestone. operationId: pull-request/milestoned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -196962,12 +197500,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *875 - milestone: *706 - number: *934 - organization: *877 - pull_request: *936 - repository: *878 + enterprise: *877 + milestone: *708 + number: *936 + organization: *879 + pull_request: *938 + repository: *880 sender: *4 required: - action @@ -196989,7 +197527,7 @@ x-webhooks: pull-request-opened: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -196997,7 +197535,7 @@ x-webhooks: description: A pull request was created operationId: pull-request/opened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -197046,12 +197584,12 @@ x-webhooks: type: string enum: - opened - enterprise: *875 - installation: *876 - number: *934 - organization: *877 - pull_request: *935 - repository: *878 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 + pull_request: *937 + repository: *880 sender: *4 required: - action @@ -197074,16 +197612,16 @@ x-webhooks: pull-request-ready-for-review: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A draft pull request was marked as ready for review. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." operationId: pull-request/ready-for-review externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -197132,12 +197670,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *875 - installation: *876 - number: *934 - organization: *877 - pull_request: *935 - repository: *878 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 + pull_request: *937 + repository: *880 sender: *4 required: - action @@ -197160,7 +197698,7 @@ x-webhooks: pull-request-reopened: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -197168,7 +197706,7 @@ x-webhooks: description: A previously closed pull request was reopened. operationId: pull-request/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -197217,12 +197755,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *875 - installation: *876 - number: *934 - organization: *877 - pull_request: *935 - repository: *878 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 + pull_request: *937 + repository: *880 sender: *4 required: - action @@ -197245,7 +197783,7 @@ x-webhooks: pull-request-review-comment-created: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -197253,7 +197791,7 @@ x-webhooks: description: A comment on a pull request diff was created. operationId: pull-request-review-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -197304,7 +197842,7 @@ x-webhooks: - created comment: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -197588,9 +198126,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 pull_request: type: object properties: @@ -199782,7 +200320,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *878 + repository: *880 sender: *4 required: - action @@ -199805,7 +200343,7 @@ x-webhooks: pull-request-review-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -199813,7 +200351,7 @@ x-webhooks: description: A comment on a pull request diff was deleted. operationId: pull-request-review-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -199862,9 +200400,9 @@ x-webhooks: type: string enum: - deleted - comment: &938 + comment: &940 title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -200147,9 +200685,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 pull_request: type: object properties: @@ -202329,7 +202867,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *878 + repository: *880 sender: *4 required: - action @@ -202352,7 +202890,7 @@ x-webhooks: pull-request-review-comment-edited: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -202360,7 +202898,7 @@ x-webhooks: description: The content of a comment on a pull request diff was changed. operationId: pull-request-review-comment/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -202409,11 +202947,11 @@ x-webhooks: type: string enum: - edited - changes: *937 - comment: *938 - enterprise: *875 - installation: *876 - organization: *877 + changes: *939 + comment: *940 + enterprise: *877 + installation: *878 + organization: *879 pull_request: type: object properties: @@ -204596,7 +205134,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *878 + repository: *880 sender: *4 required: - action @@ -204620,7 +205158,7 @@ x-webhooks: pull-request-review-dismissed: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -204628,7 +205166,7 @@ x-webhooks: description: A review on a pull request was dismissed. operationId: pull-request-review/dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -204677,9 +205215,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 pull_request: title: Simple Pull Request type: object @@ -206874,7 +207412,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *878 + repository: *880 review: description: The review that was affected. type: object @@ -207052,7 +207590,7 @@ x-webhooks: pull-request-review-edited: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -207060,7 +207598,7 @@ x-webhooks: description: The body comment on a pull request review was edited. operationId: pull-request-review/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -207121,9 +207659,9 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 pull_request: title: Simple Pull Request type: object @@ -209177,8 +209715,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *878 - review: &939 + repository: *880 + review: &941 description: The review that was affected. type: object properties: @@ -209352,7 +209890,7 @@ x-webhooks: pull-request-review-request-removed: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -209361,7 +209899,7 @@ x-webhooks: request. operationId: pull-request/review-request-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -209411,12 +209949,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 number: description: The pull request number. type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -211721,7 +212259,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 requested_reviewer: title: User type: object @@ -211805,12 +212343,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 number: description: The pull request number. type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -214122,7 +214660,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 requested_team: title: Team description: Groups of organization members that gives permissions @@ -214255,16 +214793,16 @@ x-webhooks: pull-request-review-requested: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Review by a person or team was requested for a pull request. For - more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." + more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." operationId: pull-request/review-requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -214314,12 +214852,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 number: description: The pull request number. type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -216626,7 +217164,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 requested_reviewer: title: User type: object @@ -216711,12 +217249,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *875 - installation: *876 + enterprise: *877 + installation: *878 number: description: The pull request number. type: integer - organization: *877 + organization: *879 pull_request: title: Pull Request type: object @@ -219014,7 +219552,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 requested_team: title: Team description: Groups of organization members that gives permissions @@ -219138,7 +219676,7 @@ x-webhooks: pull-request-review-submitted: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -219146,7 +219684,7 @@ x-webhooks: description: A review on a pull request was submitted. operationId: pull-request-review/submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -219195,9 +219733,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 pull_request: title: Simple Pull Request type: object @@ -221394,8 +221932,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *878 - review: *939 + repository: *880 + review: *941 sender: *4 required: - action @@ -221418,7 +221956,7 @@ x-webhooks: pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. @@ -221426,7 +221964,7 @@ x-webhooks: description: A comment thread on a pull request was marked as resolved. operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -221475,9 +222013,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 pull_request: title: Simple Pull Request type: object @@ -223569,7 +224107,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *878 + repository: *880 sender: *4 thread: type: object @@ -223578,7 +224116,7 @@ x-webhooks: type: array items: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -223898,7 +224436,7 @@ x-webhooks: pull-request-review-thread-unresolved: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. @@ -223907,7 +224445,7 @@ x-webhooks: as unresolved. operationId: pull-request-review-thread/unresolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -223956,9 +224494,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 pull_request: title: Simple Pull Request type: object @@ -226036,7 +226574,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *878 + repository: *880 sender: *4 thread: type: object @@ -226045,7 +226583,7 @@ x-webhooks: type: array items: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -226363,7 +226901,7 @@ x-webhooks: pull-request-synchronize: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -226373,7 +226911,7 @@ x-webhooks: head branch. operationId: pull-request/synchronize externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -226426,10 +226964,10 @@ x-webhooks: type: string before: type: string - enterprise: *875 - installation: *876 - number: *934 - organization: *877 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 pull_request: title: Pull Request type: object @@ -228722,7 +229260,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -228747,7 +229285,7 @@ x-webhooks: pull-request-unassigned: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -228755,7 +229293,7 @@ x-webhooks: description: A user was unassigned from a pull request. operationId: pull-request/unassigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -228804,11 +229342,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *940 - enterprise: *875 - installation: *876 - number: *934 - organization: *877 + assignee: *942 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 pull_request: title: Pull Request type: object @@ -231113,7 +231651,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -231135,7 +231673,7 @@ x-webhooks: pull-request-unlabeled: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -231143,7 +231681,7 @@ x-webhooks: description: A label was removed from a pull request. operationId: pull-request/unlabeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -231192,11 +231730,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *875 - installation: *876 - label: *898 - number: *934 - organization: *877 + enterprise: *877 + installation: *878 + label: *900 + number: *936 + organization: *879 pull_request: title: Pull Request type: object @@ -233491,7 +234029,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -233514,16 +234052,16 @@ x-webhooks: pull-request-unlocked: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations)." operationId: pull-request/unlocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -233572,10 +234110,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *875 - installation: *876 - number: *934 - organization: *877 + enterprise: *877 + installation: *878 + number: *936 + organization: *879 pull_request: title: Pull Request type: object @@ -235862,7 +236400,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *878 + repository: *880 sender: *4 required: - action @@ -235895,7 +236433,7 @@ x-webhooks: > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. operationId: push externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header @@ -235956,7 +236494,7 @@ x-webhooks: (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use - the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) + the [Commits API](https://docs.github.com/enterprise-cloud@latest/rest/commits) to fetch additional commits. type: array items: @@ -236062,7 +236600,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *875 + enterprise: *877 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -236154,8 +236692,8 @@ x-webhooks: - url - author - committer - installation: *876 - organization: *877 + installation: *878 + organization: *879 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -236684,7 +237222,7 @@ x-webhooks: registry-package-published: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. @@ -236693,7 +237231,7 @@ x-webhooks: description: A package was published to a registry. operationId: registry-package/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -236741,9 +237279,9 @@ x-webhooks: type: string enum: - published - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 registry_package: type: object properties: @@ -237189,7 +237727,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *921 + items: *923 summary: type: string tag_name: @@ -237243,7 +237781,7 @@ x-webhooks: - owner - package_version - registry - repository: *878 + repository: *880 sender: *4 required: - action @@ -237264,7 +237802,7 @@ x-webhooks: registry-package-updated: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. @@ -237273,7 +237811,7 @@ x-webhooks: description: A package that was previously published to a registry was updated. operationId: registry-package/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -237321,9 +237859,9 @@ x-webhooks: type: string enum: - updated - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 registry_package: type: object properties: @@ -237631,7 +238169,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *921 + items: *923 summary: type: string tag_name: @@ -237680,7 +238218,7 @@ x-webhooks: - owner - package_version - registry - repository: *878 + repository: *880 sender: *4 required: - action @@ -237701,14 +238239,14 @@ x-webhooks: release-created: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A draft was saved, or a release or pre-release was published without previously being saved as a draft. operationId: release/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -237757,12 +238295,12 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - release: &941 + enterprise: *877 + installation: *878 + organization: *879 + release: &943 title: Release - description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) + description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. type: object properties: @@ -238078,7 +238616,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *878 + repository: *880 sender: *4 required: - action @@ -238100,13 +238638,13 @@ x-webhooks: release-deleted: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft release was deleted. operationId: release/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -238155,11 +238693,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 - release: *941 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + release: *943 + repository: *880 sender: *4 required: - action @@ -238181,14 +238719,14 @@ x-webhooks: release-edited: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: The details of a release, pre-release, or draft release were edited. - For more information, see "[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + For more information, see "[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." operationId: release/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -238276,11 +238814,11 @@ x-webhooks: type: boolean required: - to - enterprise: *875 - installation: *876 - organization: *877 - release: *941 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + release: *943 + repository: *880 sender: *4 required: - action @@ -238302,14 +238840,14 @@ x-webhooks: release-prereleased: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable. operationId: release/prereleased externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -238358,12 +238896,12 @@ x-webhooks: type: string enum: - prereleased - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 release: title: Release - description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) + description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. type: object required: @@ -238682,7 +239220,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *878 + repository: *880 sender: *4 required: - action @@ -238703,13 +239241,13 @@ x-webhooks: release-published: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft of a release was published. operationId: release/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -238758,12 +239296,12 @@ x-webhooks: type: string enum: - published - enterprise: *875 - installation: *876 - organization: *877 - release: &942 + enterprise: *877 + installation: *878 + organization: *879 + release: &944 title: Release - description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) + description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. type: object required: @@ -239080,7 +239618,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *878 + repository: *880 sender: *4 required: - action @@ -239101,13 +239639,13 @@ x-webhooks: release-released: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was published, or a pre-release was changed to a release. operationId: release/released externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -239156,11 +239694,11 @@ x-webhooks: type: string enum: - released - enterprise: *875 - installation: *876 - organization: *877 - release: *941 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + release: *943 + repository: *880 sender: *4 required: - action @@ -239181,13 +239719,13 @@ x-webhooks: release-unpublished: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release or pre-release was unpublished. operationId: release/unpublished externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -239236,11 +239774,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *875 - installation: *876 - organization: *877 - release: *942 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + release: *944 + repository: *880 sender: *4 required: - action @@ -239261,13 +239799,13 @@ x-webhooks: repository-advisory-published: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. description: A repository security advisory was published. operationId: repository-advisory/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -239316,11 +239854,11 @@ x-webhooks: type: string enum: - published - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - repository_advisory: *776 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + repository_advisory: *778 sender: *4 required: - action @@ -239341,13 +239879,13 @@ x-webhooks: repository-advisory-reported: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. description: A private vulnerability report was submitted. operationId: repository-advisory/reported externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -239396,11 +239934,11 @@ x-webhooks: type: string enum: - reported - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - repository_advisory: *776 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + repository_advisory: *778 sender: *4 required: - action @@ -239421,13 +239959,13 @@ x-webhooks: repository-archived: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was archived. operationId: repository/archived externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -239476,10 +240014,10 @@ x-webhooks: type: string enum: - archived - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -239501,13 +240039,13 @@ x-webhooks: repository-created: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was created. operationId: repository/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -239556,10 +240094,10 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -239581,14 +240119,14 @@ x-webhooks: repository-deleted: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was deleted. GitHub Apps and repository webhooks will not receive this event. operationId: repository/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -239637,10 +240175,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -239662,12 +240200,12 @@ x-webhooks: repository-dispatch-sample.collected: post: summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: repository-dispatch/sample.collected externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_dispatch parameters: - name: User-Agent in: header @@ -239724,10 +240262,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -239749,14 +240287,14 @@ x-webhooks: repository-edited: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The topics, default branch, description, or homepage of a repository was changed. operationId: repository/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -239839,10 +240377,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -239865,11 +240403,11 @@ x-webhooks: repository-import: post: summary: This event occurs when a repository is imported to GitHub Enterprise - Cloud. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." - For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports). + Cloud. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." + For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports). operationId: repository-import externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_import parameters: - name: User-Agent in: header @@ -239914,10 +240452,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 status: type: string @@ -239943,13 +240481,13 @@ x-webhooks: repository-privatized: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The visibility of a repository was changed to `private`. operationId: repository/privatized externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -239998,10 +240536,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -240023,13 +240561,13 @@ x-webhooks: repository-publicized: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The visibility of a repository was changed to `public`. operationId: repository/publicized externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -240078,10 +240616,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -240103,13 +240641,13 @@ x-webhooks: repository-renamed: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The name of a repository was changed. operationId: repository/renamed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -240175,10 +240713,10 @@ x-webhooks: - name required: - repository - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -240202,14 +240740,14 @@ x-webhooks: post: summary: |- This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was created. operationId: repository-ruleset/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -240258,11 +240796,11 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - repository_ruleset: *193 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + repository_ruleset: *195 sender: *4 required: - action @@ -240284,14 +240822,14 @@ x-webhooks: post: summary: |- This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was deleted. operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -240340,11 +240878,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - repository_ruleset: *193 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + repository_ruleset: *195 sender: *4 required: - action @@ -240366,14 +240904,14 @@ x-webhooks: post: summary: |- This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was edited. operationId: repository-ruleset/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -240422,11 +240960,11 @@ x-webhooks: type: string enum: - edited - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - repository_ruleset: *193 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + repository_ruleset: *195 changes: type: object properties: @@ -240445,16 +240983,16 @@ x-webhooks: properties: added: type: array - items: *164 + items: *166 deleted: type: array - items: *164 + items: *166 updated: type: array items: type: object properties: - condition: *164 + condition: *166 changes: type: object properties: @@ -240487,16 +241025,16 @@ x-webhooks: properties: added: type: array - items: *744 + items: *746 deleted: type: array - items: *744 + items: *746 updated: type: array items: type: object properties: - rule: *744 + rule: *746 changes: type: object properties: @@ -240535,7 +241073,7 @@ x-webhooks: repository-transferred: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Ownership of the repository was transferred to a user or organization @@ -240545,7 +241083,7 @@ x-webhooks: events. operationId: repository/transferred externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -240730,10 +241268,10 @@ x-webhooks: - from required: - owner - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -240756,13 +241294,13 @@ x-webhooks: repository-unarchived: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A previously archived repository was unarchived. operationId: repository/unarchived externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -240811,10 +241349,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -240843,7 +241381,7 @@ x-webhooks: description: A repository vulnerability alert was created. operationId: repository-vulnerability-alert/create externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -240892,7 +241430,7 @@ x-webhooks: type: string enum: - create - alert: &943 + alert: &945 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -241014,10 +241552,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -241045,7 +241583,7 @@ x-webhooks: description: A repository vulnerability alert was dismissed. operationId: repository-vulnerability-alert/dismiss externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -241223,10 +241761,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -241255,7 +241793,7 @@ x-webhooks: was reopened. operationId: repository-vulnerability-alert/reopen externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -241304,11 +241842,11 @@ x-webhooks: type: string enum: - reopen - alert: *943 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + alert: *945 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -241336,7 +241874,7 @@ x-webhooks: description: A repository vulnerability alert was marked as resolved. operationId: repository-vulnerability-alert/resolve externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -241507,10 +242045,10 @@ x-webhooks: enum: - fixed - open - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -241531,7 +242069,7 @@ x-webhooks: secret-scanning-alert-assigned: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -241539,7 +242077,7 @@ x-webhooks: description: A secret scanning alert was assigned. operationId: secret-scanning-alert/assigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -241588,7 +242126,7 @@ x-webhooks: type: string enum: - assigned - alert: &944 + alert: &946 type: object properties: number: *131 @@ -241642,7 +242180,7 @@ x-webhooks: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." provider: type: string description: The provider of the secret that was detected. @@ -241731,10 +242269,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -241755,7 +242293,7 @@ x-webhooks: secret-scanning-alert-created: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -241763,7 +242301,7 @@ x-webhooks: description: A secret scanning alert was created. operationId: secret-scanning-alert/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -241812,11 +242350,11 @@ x-webhooks: type: string enum: - created - alert: *944 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + alert: *946 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -241839,7 +242377,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. @@ -241848,7 +242386,7 @@ x-webhooks: a repository, and the location of the secret was added to the existing alert. operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -241897,11 +242435,11 @@ x-webhooks: type: string enum: - created - alert: *944 - installation: *876 - location: *945 - organization: *877 - repository: *878 + alert: *946 + installation: *878 + location: *947 + organization: *879 + repository: *880 sender: *4 required: - location @@ -242082,7 +242620,7 @@ x-webhooks: secret-scanning-alert-publicly-leaked: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -242090,7 +242628,7 @@ x-webhooks: description: A secret scanning alert was detected in a public repo. operationId: secret-scanning-alert/publicly-leaked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -242139,11 +242677,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *944 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + alert: *946 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -242164,7 +242702,7 @@ x-webhooks: secret-scanning-alert-reopened: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -242172,7 +242710,7 @@ x-webhooks: description: A previously closed secret scanning alert was reopened. operationId: secret-scanning-alert/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -242221,11 +242759,11 @@ x-webhooks: type: string enum: - reopened - alert: *944 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + alert: *946 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -242246,7 +242784,7 @@ x-webhooks: secret-scanning-alert-resolved: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -242254,7 +242792,7 @@ x-webhooks: description: A secret scanning alert was closed. operationId: secret-scanning-alert/resolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -242303,11 +242841,11 @@ x-webhooks: type: string enum: - resolved - alert: *944 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + alert: *946 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -242328,7 +242866,7 @@ x-webhooks: secret-scanning-alert-unassigned: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -242336,7 +242874,7 @@ x-webhooks: description: A secret scanning alert was unassigned. operationId: secret-scanning-alert/unassigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -242385,12 +242923,12 @@ x-webhooks: type: string enum: - unassigned - alert: *944 + alert: *946 assignee: *4 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -242411,7 +242949,7 @@ x-webhooks: secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -242419,7 +242957,7 @@ x-webhooks: description: A secret scanning alert was validated. operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -242468,11 +243006,11 @@ x-webhooks: type: string enum: - validated - alert: *944 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + alert: *946 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -242493,16 +243031,16 @@ x-webhooks: secret-scanning-scan-completed: post: summary: |- - This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." + This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates - to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A secret scanning scan was completed. operationId: secret-scanning-scan/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_scan parameters: - name: User-Agent in: header @@ -242598,10 +243136,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *878 - enterprise: *875 - installation: *876 - organization: *877 + repository: *880 + enterprise: *877 + installation: *878 + organization: *879 sender: *4 required: - action @@ -242624,13 +243162,13 @@ x-webhooks: security-advisory-published: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory). - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: A security advisory was published to the GitHub community. operationId: security-advisory/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -242679,11 +243217,11 @@ x-webhooks: type: string enum: - published - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - security_advisory: &946 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + security_advisory: &948 description: The details of the security advisory, including summary, description, and severity. type: object @@ -242811,13 +243349,13 @@ x-webhooks: security-advisory-updated: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory). - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: The metadata or description of a security advisory was changed. operationId: security-advisory/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -242866,11 +243404,11 @@ x-webhooks: type: string enum: - updated - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 - security_advisory: *946 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 + security_advisory: *948 sender: *4 required: - action @@ -242888,13 +243426,13 @@ x-webhooks: security-advisory-withdrawn: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory). - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: A previously published security advisory was withdrawn. operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -242943,10 +243481,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -243074,12 +243612,12 @@ x-webhooks: security-and-analysis: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features)." + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/enterprise-cloud@latest/code-security/getting-started/github-security-features)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. operationId: security-and-analysis externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -243130,11 +243668,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *437 - enterprise: *875 - installation: *876 - organization: *877 - repository: *483 + security_and_analysis: *439 + enterprise: *877 + installation: *878 + organization: *879 + repository: *485 sender: *4 required: - changes @@ -243154,16 +243692,16 @@ x-webhooks: sponsorship-cancelled: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- A sponsorship was cancelled and the last billing cycle has ended. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. operationId: sponsorship/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -243212,12 +243750,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - sponsorship: &947 + sponsorship: &949 type: object properties: created_at: @@ -243462,14 +244000,14 @@ x-webhooks: sponsorship-created: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed. operationId: sponsorship/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -243518,12 +244056,12 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - sponsorship: *947 + sponsorship: *949 required: - action - sponsorship @@ -243541,15 +244079,15 @@ x-webhooks: sponsorship-edited: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs. operationId: sponsorship/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -243611,12 +244149,12 @@ x-webhooks: type: string required: - from - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - sponsorship: *947 + sponsorship: *949 required: - action - changes @@ -243635,16 +244173,16 @@ x-webhooks: sponsorship-pending-cancellation: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. operationId: sponsorship/pending-cancellation externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -243693,17 +244231,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &948 + effective_date: &950 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - sponsorship: *947 + sponsorship: *949 required: - action - sponsorship @@ -243721,14 +244259,14 @@ x-webhooks: sponsorship-pending-tier-change: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date. operationId: sponsorship/pending-tier-change externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -243777,7 +244315,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &949 + changes: &951 type: object properties: tier: @@ -243821,13 +244359,13 @@ x-webhooks: - from required: - tier - effective_date: *948 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + effective_date: *950 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - sponsorship: *947 + sponsorship: *949 required: - action - changes @@ -243846,16 +244384,16 @@ x-webhooks: sponsorship-tier-changed: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle. operationId: sponsorship/tier-changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -243904,13 +244442,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *949 - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + changes: *951 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - sponsorship: *947 + sponsorship: *949 required: - action - changes @@ -243929,13 +244467,13 @@ x-webhooks: star-created: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone starred a repository. operationId: star/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -243984,10 +244522,10 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -244015,13 +244553,13 @@ x-webhooks: star-deleted: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone unstarred the repository. operationId: star/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -244070,10 +244608,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -244100,12 +244638,12 @@ x-webhooks: status: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)" in the REST API documentation. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. operationId: status externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -244493,15 +245031,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *875 + enterprise: *877 id: description: The unique identifier of the status. type: integer - installation: *876 + installation: *878 name: type: string - organization: *877 - repository: *878 + organization: *879 + repository: *880 sender: *4 sha: description: The Commit SHA. @@ -244558,7 +245096,7 @@ x-webhooks: description: A parent issue was added to an issue. operationId: sub-issues/parent-issue-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -244610,15 +245148,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 + parent_issue: *229 parent_issue_repo: *80 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - installation: *876 - organization: *877 - repository: *878 + sub_issue: *229 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -244650,7 +245188,7 @@ x-webhooks: description: A parent issue was removed from an issue. operationId: sub-issues/parent-issue-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -244702,15 +245240,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 + parent_issue: *229 parent_issue_repo: *80 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - installation: *876 - organization: *877 - repository: *878 + sub_issue: *229 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -244742,7 +245280,7 @@ x-webhooks: description: A sub-issue was added to an issue. operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -244794,15 +245332,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 + sub_issue: *229 sub_issue_repo: *80 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - installation: *876 - organization: *877 - repository: *878 + parent_issue: *229 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -244834,7 +245372,7 @@ x-webhooks: description: A sub-issue was removed from an issue. operationId: sub-issues/sub-issue-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -244886,15 +245424,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 + sub_issue: *229 sub_issue_repo: *80 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - installation: *876 - organization: *877 - repository: *878 + parent_issue: *229 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -244919,14 +245457,14 @@ x-webhooks: post: summary: |- This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. operationId: team-add externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -244971,12 +245509,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - team: &950 + team: &952 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -245144,13 +245682,13 @@ x-webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was granted access to a repository. operationId: team/added-to-repository externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -245199,9 +245737,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 repository: title: Repository description: A git repository @@ -245659,7 +246197,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *950 + team: *952 required: - action - team @@ -245680,13 +246218,13 @@ x-webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was created. operationId: team/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -245735,9 +246273,9 @@ x-webhooks: type: string enum: - created - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 repository: title: Repository description: A git repository @@ -246195,7 +246733,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *950 + team: *952 required: - action - team @@ -246217,13 +246755,13 @@ x-webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was deleted. operationId: team/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -246272,9 +246810,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 repository: title: Repository description: A git repository @@ -246732,7 +247270,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *950 + team: *952 required: - action - team @@ -246753,13 +247291,13 @@ x-webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: The name, description, or visibility of a team was changed. operationId: team/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -246876,9 +247414,9 @@ x-webhooks: - from required: - permissions - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 repository: title: Repository description: A git repository @@ -247336,7 +247874,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *950 + team: *952 required: - action - changes @@ -247359,13 +247897,13 @@ x-webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team's access to a repository was removed. operationId: team/removed-from-repository externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -247414,9 +247952,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *875 - installation: *876 - organization: *877 + enterprise: *877 + installation: *878 + organization: *879 repository: title: Repository description: A git repository @@ -247874,7 +248412,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *950 + team: *952 required: - action - team @@ -247895,13 +248433,13 @@ x-webhooks: watch-started: post: summary: |- - This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest//account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching)" in the REST API documentation. + This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone started watching the repository. operationId: watch/started externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#watch + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#watch parameters: - name: User-Agent in: header @@ -247950,10 +248488,10 @@ x-webhooks: type: string enum: - started - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 required: - action @@ -247974,14 +248512,14 @@ x-webhooks: workflow-dispatch: post: summary: |- - This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/manually-running-a-workflow)." + This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs/manually-running-a-workflow)." For activity relating to workflow runs, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: workflow-dispatch externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_dispatch + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_dispatch parameters: - name: User-Agent in: header @@ -248026,16 +248564,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *875 + enterprise: *877 inputs: type: object nullable: true additionalProperties: true - installation: *876 - organization: *877 + installation: *878 + organization: *879 ref: type: string - repository: *878 + repository: *880 sender: *4 workflow: type: string @@ -248058,7 +248596,7 @@ x-webhooks: workflow-job-completed: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. @@ -248068,7 +248606,7 @@ x-webhooks: unsuccessful. operationId: workflow-job/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -248117,10 +248655,10 @@ x-webhooks: type: string enum: - completed - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 workflow_job: allOf: @@ -248160,7 +248698,7 @@ x-webhooks: type: integer labels: description: Custom labels for the job. Specified by the [`"runs-on"` - attribute](https://docs.github.com/enterprise-cloud@latest//actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) + attribute](https://docs.github.com/enterprise-cloud@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. type: array items: @@ -248357,7 +248895,7 @@ x-webhooks: type: string required: - conclusion - deployment: *625 + deployment: *627 required: - action - repository @@ -248379,7 +248917,7 @@ x-webhooks: workflow-job-in-progress: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. @@ -248387,7 +248925,7 @@ x-webhooks: description: A job in a workflow run started processing on a runner. operationId: workflow-job/in-progress externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -248436,10 +248974,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 workflow_job: allOf: @@ -248476,7 +249014,7 @@ x-webhooks: type: integer labels: description: Custom labels for the job. Specified by the [`"runs-on"` - attribute](https://docs.github.com/enterprise-cloud@latest//actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) + attribute](https://docs.github.com/enterprise-cloud@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. type: array items: @@ -248699,7 +249237,7 @@ x-webhooks: required: - status - steps - deployment: *625 + deployment: *627 required: - action - repository @@ -248721,7 +249259,7 @@ x-webhooks: workflow-job-queued: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. @@ -248729,7 +249267,7 @@ x-webhooks: description: A job in a workflow run was created. operationId: workflow-job/queued externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -248778,10 +249316,10 @@ x-webhooks: type: string enum: - queued - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 workflow_job: type: object @@ -248916,7 +249454,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *625 + deployment: *627 required: - action - repository @@ -248938,7 +249476,7 @@ x-webhooks: workflow-job-waiting: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. @@ -248946,7 +249484,7 @@ x-webhooks: description: A job in a workflow run was created and is waiting for approvals. operationId: workflow-job/waiting externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -248995,10 +249533,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 workflow_job: type: object @@ -249134,7 +249672,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *625 + deployment: *627 required: - action - repository @@ -249156,7 +249694,7 @@ x-webhooks: workflow-run-completed: post: summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)" in the REST API documentation. + This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. @@ -249165,7 +249703,7 @@ x-webhooks: is completed, regardless of whether the workflow was successful or unsuccessful. operationId: workflow-run/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header @@ -249214,12 +249752,12 @@ x-webhooks: type: string enum: - completed - enterprise: *875 - installation: *876 - organization: *877 - repository: *878 + enterprise: *877 + installation: *878 + organization: *879 + repository: *880 sender: *4 - workflow: *894 + workflow: *896 workflow_run: title: Workflow Run type: object @@ -250161,7 +250699,7 @@ x-webhooks: workflow-run-in-progress: post: summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)" in the REST API documentation. + This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/ref{"code":"deadline_exceeded","msg":"operation timed out"}